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

22 days ago

main
1.0.2
Compare

API structure has changed

This documentation update aligns with a release. Check out the release notes.

40 structure changes including:
19 Additions
21 Modifications
Modified 21 Breaking
DELETE /api/asset_criticality
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • entity property Added
GET /api/asset_criticality
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Added
GET /api/asset_criticality/list
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • entity property Added
GET /api/dashboards/dashboard/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
        • attributes property Modified
GET /api/fleet/agents
  • Query
  • showAgentless query parameter Added
GET /api/fleet/remote_synced_integrations/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrations property Modified
        • install_status, warning properties Added
      • warning property Added
GET /api/fleet/remote_synced_integrations/{outputId}/remote_status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrations property Modified
        • install_status, warning properties Added
      • warning property Added
POST /api/actions/connector/{id}
  • Body
  • application/json content type Modified
    • config property Modified
      • genai_openai_other_config alternative Added
    • secrets property Modified
      • genai_secrets alternative Modified
        • certificateData, privateKeyData, caData properties Added
      • defender_secrets alternative Added
POST /api/actions/connector/{id}/_execute
  • Body
  • application/json content type Modified
    • params property Modified
      • run_getagentdetails, run_getagents alternatives Added
POST /api/alerting/rule/{id}/snooze_schedule
  • Operation is now Generally available
POST /api/asset_criticality
  • Response
  • 200 response Modified
    • application/json content type Modified
      • entity property Added
POST /api/dashboards/dashboard/{id}
  • Body
  • application/json content type Modified
    • attributes property Modified
      • panels property Modified
        • object alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
        • attributes property Modified
POST /api/detection_engine/rules/_bulk_action
  • Body
  • application/json content type Modified
    • Security_Detections_API_BulkDeleteRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkDisableRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkEnableRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkExportRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkDuplicateRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkManualRuleRun alternative Modified
      • gaps_range_end, gaps_range_start properties Added
    • Security_Detections_API_BulkEditRules alternative Modified
      • gaps_range_end, gaps_range_start properties Added
POST /api/fleet/epm/custom_integrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _meta property Modified
        • name property Added
POST /api/fleet/epm/packages
  • Response
  • 200 response Modified
    • application/gzip; application/zip content type Modified
      • _meta property Modified
        • name property Added
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • _meta property Modified
        • name property Added
PUT /api/actions/connector/{id}
  • Body
  • application/json content type Modified
    • config property Modified
      • defender_config alternative Added
    • secrets property Modified
      • genai_secrets alternative Modified
        • certificateData, privateKeyData, caData properties Added
PUT /api/dashboards/dashboard/{id}
  • Body
  • application/json content type Modified
    • attributes property Modified
      • panels property Modified
        • object alternative Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 alternatives Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
        • attributes property Modified
PUT /api/streams/{name}
  • Body
  • application/json content type Modified
    • object-8 alternative Modified
      • stream property Modified
        • ingest property Modified
    • object-8 alternative Modified
      • stream property Modified
        • ingest property Modified
PUT /api/streams/{name}/_ingest
  • Body
  • application/json content type Modified
    • ingest property Modified
      • object-2 alternative Modified
        • processing property Modified
        • unwired property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • wired property Added
      • object-2 alternative Modified
        • processing property Modified
DELETE /api/alerting/rule/{ruleId}/snooze_schedule/{scheduleId}
  • Operation is now Generally available
Added 19
DELETE /api/entity_analytics/monitoring/users/{id}
DELETE /api/fleet/epm/packages/{pkgName}/{pkgVersion}/datastream_assets
DELETE /api/maintenance_window/{id}
GET /api/entity_analytics/monitoring/users/list
GET /api/entity_analytics/monitoring/users/{id}
GET /api/fleet/epm/packages/_bulk_uninstall/{taskId}
GET /api/fleet/epm/packages/_bulk_upgrade/{taskId}
GET /api/maintenance_window/{id}
PATCH /api/maintenance_window/{id}
POST /api/entity_analytics/monitoring/users
POST /api/entity_analytics/monitoring/users/_csv
POST /api/entity_analytics/monitoring/users/_json
POST /api/fleet/agents/{agentId}/migrate
POST /api/fleet/epm/packages/_bulk_uninstall
POST /api/fleet/epm/packages/_bulk_upgrade
POST /api/maintenance_window
POST /api/maintenance_window/{id}/_archive
POST /api/maintenance_window/{id}/_unarchive
PUT /api/entity_analytics/monitoring/users/{id}