Change Updates

Do not miss any Kibana Serverless API changes, ever again

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

RSS

15 days ago

main
1.0.2
Compare

API structure has changed

42 structure changes including:
8 Additions
34 Modifications
Modified 34
GET /api/fleet/settings
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • prerelease_integrations_enabled property Modified

          • Property is no longer required

        • delete_unenrolled_agents property Added
GET /api/note
  • Query
  • userFilter, associatedFilter query parameters Added
GET /api/spaces/space
  • Response
  • 200 response Added
GET /api/spaces/space/{id}
  • Response
  • 200 response Added
PATCH /api/detection_engine/rules
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • Security_Detections_API_ThresholdRulePatchFields alternative Modified
      • response_actions property Added
    • Security_Detections_API_ThreatMatchRulePatchFields alternative Modified
      • response_actions property Added
    • Security_Detections_API_MachineLearningRulePatchFields alternative Modified
      • response_actions property Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • Security_Detections_API_ThresholdRuleResponseFields alternative Modified
        • response_actions property Added
      • Security_Detections_API_ThreatMatchRuleResponseFields alternative Modified
        • response_actions property Added
      • Security_Detections_API_MachineLearningRuleResponseFields alternative Modified
        • response_actions property Added
POST /api/actions/connector/{id}
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • secrets property Modified
      • gemini_secrets alternative Modified
        • credentialsJson property Modified

          • Name went from credentialsJSON to credentialsJson

POST /api/alerting/rule/{id}
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • flapping property Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • flapping property Added
POST /api/alerting/rule/{id}/_mute_all
  • Response
  • 400, 403, 404 responses Added
POST /api/alerting/rule/{id}/_unmute_all
  • Response
  • 400, 403, 404 responses Added
POST /api/detection_engine/rules
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • Security_Detections_API_ThresholdRuleCreateFields alternative Modified
      • response_actions property Added
    • Security_Detections_API_ThreatMatchRuleCreateFields alternative Modified
      • response_actions property Added
    • Security_Detections_API_MachineLearningRuleCreateFields alternative Modified
      • response_actions property Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • Security_Detections_API_ThresholdRuleResponseFields alternative Modified
        • response_actions property Added
      • Security_Detections_API_ThreatMatchRuleResponseFields alternative Modified
        • response_actions property Added
      • Security_Detections_API_MachineLearningRuleResponseFields alternative Modified
        • response_actions property Added
POST /api/detection_engine/rules/_bulk_action
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • Security_Detections_API_BulkEditActionResponse alternative Modified
        • attributes property Modified
POST /api/detection_engine/rules/preview
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • Security_Detections_API_RulePreviewParams alternative Modified
      • data_view_id, event_category_override, filters, index, tiebreaker_field, timestamp_field properties Added
    • Security_Detections_API_RulePreviewParams alternative Modified
      • language, query properties Modified

        • Properties are no longer required

      • data_view_id, filters, index, saved_id properties Added
    • Security_Detections_API_RulePreviewParams alternative Modified
      • query, language properties Modified

        • Properties are no longer required

      • saved_id, data_view_id, filters, index properties Added
    • Security_Detections_API_RulePreviewParams alternative Modified
      • alert_suppression property Modified
        • duration property Modified

          • Property is now required

        • group_by, missing_fields_strategy properties Removed
      • language property Modified

        • Property is no longer required

      • threshold, data_view_id, filters, index, saved_id properties Added
    • Security_Detections_API_RulePreviewParams alternative Modified
      • language property Modified

        • Property is no longer required

      • threat_index, threat_mapping, threat_query, concurrent_searches, data_view_id, filters, index, items_per_search, saved_id, threat_filters, threat_indicator_path, threat_language properties Added
    • Security_Detections_API_RulePreviewParams alternative Modified
      • language, query properties Removed
      • anomaly_threshold property Added
      • machine_learning_job_id property Added
        • string-1, array-2 properties Added
    • Security_Detections_API_RulePreviewParams alternative Modified
      • language property Modified

        • Property is no longer required

      • history_window_start, new_terms_fields, data_view_id, filters, index properties Added
POST /api/endpoint/suggestions/{suggestion_type}
  • Operation is now deprecated
POST /api/entity_store/engines/{entityType}/init
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • fieldHistoryLength property Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • indexPattern, status, type properties Modified

        • Properties are now required

      • fieldHistoryLength property Added
POST /api/spaces/space
  • Response
  • 200 response Added
PUT /api/actions/connector/{id}
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • secrets property Modified
      • gemini_secrets alternative Modified
        • credentialsJson property Modified

          • Name went from credentialsJSON to credentialsJson

PUT /api/alerting/rule/{id}
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • flapping property Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • flapping property Added
PUT /api/detection_engine/rules
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • Security_Detections_API_ThresholdRuleCreateFields alternative Modified
      • response_actions property Added
    • Security_Detections_API_ThreatMatchRuleCreateFields alternative Modified
      • response_actions property Added
    • Security_Detections_API_MachineLearningRuleCreateFields alternative Modified
      • response_actions property Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • Security_Detections_API_ThresholdRuleResponseFields alternative Modified
        • response_actions property Added
      • Security_Detections_API_ThreatMatchRuleResponseFields alternative Modified
        • response_actions property Added
      • Security_Detections_API_MachineLearningRuleResponseFields alternative Modified
        • response_actions property Added
PUT /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • discovery property Added
      • response property Modified
        • discovery property Added
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
        • prerelease_integrations_enabled property Modified

          • Property is no longer required

        • delete_unenrolled_agents property Added
PUT /api/spaces/space/{id}
  • Response
  • 200 response Added
DELETE /api/detection_engine/rules
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • Security_Detections_API_ThresholdRuleResponseFields alternative Modified
        • response_actions property Added
      • Security_Detections_API_ThreatMatchRuleResponseFields alternative Modified
        • response_actions property Added
      • Security_Detections_API_MachineLearningRuleResponseFields alternative Modified
        • response_actions property Added
DELETE /api/spaces/space/{id}
  • Response
  • 204, 404 responses Added
GET /api/alerting/rule/{id}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • flapping property Added
GET /api/alerting/rules/_find
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • flapping property Added
GET /api/detection_engine/rules
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • Security_Detections_API_ThresholdRuleResponseFields alternative Modified
        • response_actions property Added
      • Security_Detections_API_ThreatMatchRuleResponseFields alternative Modified
        • response_actions property Added
      • Security_Detections_API_MachineLearningRuleResponseFields alternative Modified
        • response_actions property Added
GET /api/detection_engine/rules/_find
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • data property Modified
        • Security_Detections_API_ThresholdRuleResponseFields, Security_Detections_API_ThreatMatchRuleResponseFields, Security_Detections_API_MachineLearningRuleResponseFields alternatives Modified
GET /api/endpoint/metadata/transforms
  • Operation is now deprecated
GET /api/entity_store/engines
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • engines property Modified
        • indexPattern, status, type properties Modified

          • Properties are now required

        • fieldHistoryLength property Added
GET /api/entity_store/engines/{entityType}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • indexPattern, status, type properties Modified

        • Properties are now required

      • fieldHistoryLength property Added
GET /api/entity_store/entities/list
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • records property Modified
        • Security_Entity_Analytics_API_UserEntity, Security_Entity_Analytics_API_HostEntity alternatives Modified
GET /api/fleet/agent_policies
  • Query
  • noAgentCount query parameter Modified

    • Query parameter is now deprecated

  • withAgentCount query parameter Added
GET /api/fleet/epm/packages
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • discovery property Added
      • response property Modified
        • discovery property 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
        • discovery property Added
      • response property Modified
        • discovery property Added
Added 8
PUT /api/security/role/{name}
POST /api/security/roles
POST /api/fleet/agent_policies/outputs
POST /api/entity_store/engines/apply_dataview_indices
GET /api/security/role/{name}
GET /api/security/role
GET /api/fleet/agent_policies/{agentPolicyId}/outputs
DELETE /api/security/role/{name}