Change Updates

Do not miss any Kibana API changes, ever again

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

RSS

Oct 1, 2024

v8
1.0.2
Compare

API structure has changed

This documentation update aligns with 8.15.2. The Fleet API changes fix a documentation error (https://github.com/elastic/kibana/pull/192652).

105 structure changes including:
94 Breaking changes
104 Modifications
1 Removal
Modified 104 Breaking
DELETE /api/fleet/agent_download_sources/{sourceId}
  • Path went from /agent_download_sources/{sourceId} to /api/fleet/agent_download_sources/{sourceId} (same operationId)
    Breaking
DELETE /api/fleet/agents/files/{fileId}
  • Path went from /agents/files/{fileId} to /api/fleet/agents/files/{fileId} (same operationId)
    Breaking
DELETE /api/fleet/agents/{agentId}
  • Path went from /agents/{agentId} to /api/fleet/agents/{agentId} (same operationId)
    Breaking
DELETE /api/fleet/enrollment-api-keys/{keyId}
  • Path went from /enrollment-api-keys/{keyId} to /api/fleet/enrollment-api-keys/{keyId} (same operationId)
DELETE /api/fleet/enrollment_api_keys/{keyId}
  • Path went from /enrollment_api_keys/{keyId} to /api/fleet/enrollment_api_keys/{keyId} (same operationId)
    Breaking
DELETE /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Path went from /epm/packages/{pkgName}/{pkgVersion} to /api/fleet/epm/packages/{pkgName}/{pkgVersion} (same operationId)
    Breaking
DELETE /api/fleet/epm/packages/{pkgkey}
  • Path went from /epm/packages/{pkgkey} to /api/fleet/epm/packages/{pkgkey} (same operationId)
DELETE /api/fleet/fleet_server_hosts/{itemId}
  • Path went from /fleet_server_hosts/{itemId} to /api/fleet/fleet_server_hosts/{itemId} (same operationId)
    Breaking
DELETE /api/fleet/outputs/{outputId}
  • Path went from /outputs/{outputId} to /api/fleet/outputs/{outputId} (same operationId)
    Breaking
DELETE /api/fleet/package_policies/{packagePolicyId}
  • Path went from /package_policies/{packagePolicyId} to /api/fleet/package_policies/{packagePolicyId} (same operationId)
    Breaking
DELETE /api/fleet/proxies/{itemId}
  • Path went from /proxies/{itemId} to /api/fleet/proxies/{itemId} (same operationId)
    Breaking
GET /api/fleet/agent-status
  • Path went from /agent-status to /api/fleet/agent-status (same operationId)
GET /api/fleet/agent_download_sources
  • Path went from /agent_download_sources to /api/fleet/agent_download_sources (same operationId)
    Breaking
GET /api/fleet/agent_download_sources/{sourceId}
  • Path went from /agent_download_sources/{sourceId} to /api/fleet/agent_download_sources/{sourceId} (same operationId)
    Breaking
GET /api/fleet/agent_policies
  • Path went from /agent_policies to /api/fleet/agent_policies (same operationId)
    Breaking
GET /api/fleet/agent_policies/{agentPolicyId}
  • Path went from /agent_policies/{agentPolicyId} to /api/fleet/agent_policies/{agentPolicyId} (same operationId)
    Breaking
GET /api/fleet/agent_policies/{agentPolicyId}/download
  • Path went from /agent_policies/{agentPolicyId}/download to /api/fleet/agent_policies/{agentPolicyId}/download (same operationId)
    Breaking
GET /api/fleet/agent_policies/{agentPolicyId}/full
  • Path went from /agent_policies/{agentPolicyId}/full to /api/fleet/agent_policies/{agentPolicyId}/full (same operationId)
    Breaking
GET /api/fleet/agent_status
  • Path went from /agent_status to /api/fleet/agent_status (same operationId)
    Breaking
GET /api/fleet/agent_status/data
  • Path went from /agent_status/data to /api/fleet/agent_status/data (same operationId)
    Breaking
GET /api/fleet/agents
  • Path went from /agents to /api/fleet/agents (same operationId)
    Breaking
GET /api/fleet/agents/action_status
  • Path went from /agents/action_status to /api/fleet/agents/action_status (same operationId)
    Breaking
GET /api/fleet/agents/files/{fileId}/{fileName}
  • Path went from /agents/files/{fileId}/{fileName} to /api/fleet/agents/files/{fileId}/{fileName} (same operationId)
    Breaking
GET /api/fleet/agents/setup
  • Path went from /agents/setup to /api/fleet/agents/setup (same operationId)
    Breaking
GET /api/fleet/agents/tags
  • Path went from /agents/tags to /api/fleet/agents/tags (same operationId)
    Breaking
GET /api/fleet/agents/{agentId}
  • Path went from /agents/{agentId} to /api/fleet/agents/{agentId} (same operationId)
    Breaking
GET /api/fleet/agents/{agentId}/uploads
  • Path went from /agents/{agentId}/uploads to /api/fleet/agents/{agentId}/uploads (same operationId)
    Breaking
GET /api/fleet/data_streams
  • Path went from /data_streams to /api/fleet/data_streams (same operationId)
    Breaking
GET /api/fleet/enrollment-api-keys
  • Path went from /enrollment-api-keys to /api/fleet/enrollment-api-keys (same operationId)
GET /api/fleet/enrollment-api-keys/{keyId}
  • Path went from /enrollment-api-keys/{keyId} to /api/fleet/enrollment-api-keys/{keyId} (same operationId)
GET /api/fleet/enrollment_api_keys
  • Path went from /enrollment_api_keys to /api/fleet/enrollment_api_keys (same operationId)
    Breaking
GET /api/fleet/enrollment_api_keys/{keyId}
  • Path went from /enrollment_api_keys/{keyId} to /api/fleet/enrollment_api_keys/{keyId} (same operationId)
    Breaking
GET /api/fleet/epm/categories
  • Path went from /epm/categories to /api/fleet/epm/categories (same operationId)
    Breaking
GET /api/fleet/epm/packages
  • Path went from /epm/packages to /api/fleet/epm/packages (same operationId)
    Breaking
GET /api/fleet/epm/packages/limited
  • Path went from /epm/packages/limited to /api/fleet/epm/packages/limited (same operationId)
    Breaking
GET /api/fleet/epm/packages/{pkgName}/stats
  • Path went from /epm/packages/{pkgName}/stats to /api/fleet/epm/packages/{pkgName}/stats (same operationId)
    Breaking
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Path went from /epm/packages/{pkgName}/{pkgVersion} to /api/fleet/epm/packages/{pkgName}/{pkgVersion} (same operationId)
    Breaking
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath}
  • Path went from /epm/packages/{pkgName}/{pkgVersion}/{filePath} to /api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath} (same operationId)
    Breaking
GET /api/fleet/epm/packages/{pkgkey}
  • Path went from /epm/packages/{pkgkey} to /api/fleet/epm/packages/{pkgkey} (same operationId)
GET /api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs
  • Path went from /epm/templates/{pkgName}/{pkgVersion}/inputs to /api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs (same operationId)
    Breaking
GET /api/fleet/epm/verification_key_id
  • Path went from /epm/verification_key_id to /api/fleet/epm/verification_key_id (same operationId)
    Breaking
GET /api/fleet/fleet_server_hosts
  • Path went from /fleet_server_hosts to /api/fleet/fleet_server_hosts (same operationId)
    Breaking
GET /api/fleet/fleet_server_hosts/{itemId}
  • Path went from /fleet_server_hosts/{itemId} to /api/fleet/fleet_server_hosts/{itemId} (same operationId)
    Breaking
GET /api/fleet/kubernetes
  • Path went from /kubernetes to /api/fleet/kubernetes (same operationId)
    Breaking
GET /api/fleet/outputs
  • Path went from /outputs to /api/fleet/outputs (same operationId)
    Breaking
GET /api/fleet/outputs/{outputId}
  • Path went from /outputs/{outputId} to /api/fleet/outputs/{outputId} (same operationId)
    Breaking
GET /api/fleet/outputs/{outputId}/health
  • Path went from /outputs/{outputId}/health to /api/fleet/outputs/{outputId}/health (same operationId)
    Breaking
GET /api/fleet/package_policies
  • Path went from /package_policies to /api/fleet/package_policies (same operationId)
    Breaking
GET /api/fleet/package_policies/{packagePolicyId}
  • Path went from /package_policies/{packagePolicyId} to /api/fleet/package_policies/{packagePolicyId} (same operationId)
    Breaking
GET /api/fleet/proxies
  • Path went from /proxies to /api/fleet/proxies (same operationId)
    Breaking
GET /api/fleet/proxies/{itemId}
  • Path went from /proxies/{itemId} to /api/fleet/proxies/{itemId} (same operationId)
    Breaking
GET /api/fleet/settings
  • Path went from /settings to /api/fleet/settings (same operationId)
    Breaking
GET /api/fleet/uninstall_tokens
  • Path went from /uninstall_tokens to /api/fleet/uninstall_tokens (same operationId)
    Breaking
GET /api/fleet/uninstall_tokens/{uninstallTokenId}
  • Path went from /uninstall_tokens/{uninstallTokenId} to /api/fleet/uninstall_tokens/{uninstallTokenId} (same operationId)
    Breaking
POST /api/actions/connector/{connectorId}/_execute
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • params property Modified
      • Connectors_run_connector_subaction_pushtoservice alternative Modified
        • subActionParams property Modified
POST /api/fleet/agent_download_sources
  • Path went from /agent_download_sources to /api/fleet/agent_download_sources (same operationId)
    Breaking
POST /api/fleet/agent_policies
  • Path went from /agent_policies to /api/fleet/agent_policies (same operationId)
    Breaking
POST /api/fleet/agent_policies/_bulk_get
  • Path went from /agent_policies/_bulk_get to /api/fleet/agent_policies/_bulk_get (same operationId)
    Breaking
POST /api/fleet/agent_policies/delete
  • Path went from /agent_policies/delete to /api/fleet/agent_policies/delete (same operationId)
    Breaking
POST /api/fleet/agent_policies/{agentPolicyId}/copy
  • Path went from /agent_policies/{agentPolicyId}/copy to /api/fleet/agent_policies/{agentPolicyId}/copy (same operationId)
    Breaking
POST /api/fleet/agents
  • Path went from /agents to /api/fleet/agents (same operationId)
    Breaking
POST /api/fleet/agents/bulk_reassign
  • Path went from /agents/bulk_reassign to /api/fleet/agents/bulk_reassign (same operationId)
    Breaking
POST /api/fleet/agents/bulk_request_diagnostics
  • Path went from /agents/bulk_request_diagnostics to /api/fleet/agents/bulk_request_diagnostics (same operationId)
    Breaking
POST /api/fleet/agents/bulk_unenroll
  • Path went from /agents/bulk_unenroll to /api/fleet/agents/bulk_unenroll (same operationId)
    Breaking
POST /api/fleet/agents/bulk_update_agent_tags
  • Path went from /agents/bulk_update_agent_tags to /api/fleet/agents/bulk_update_agent_tags (same operationId)
    Breaking
POST /api/fleet/agents/bulk_upgrade
  • Path went from /agents/bulk_upgrade to /api/fleet/agents/bulk_upgrade (same operationId)
    Breaking
POST /api/fleet/agents/setup
  • Path went from /agents/setup to /api/fleet/agents/setup (same operationId)
    Breaking
POST /api/fleet/agents/{agentId}/actions
  • Path went from /agents/{agentId}/actions to /api/fleet/agents/{agentId}/actions (same operationId)
    Breaking
POST /api/fleet/agents/{agentId}/actions/{actionId}/cancel
  • Path went from /agents/{agentId}/actions/{actionId}/cancel to /api/fleet/agents/{agentId}/actions/{actionId}/cancel (same operationId)
    Breaking
POST /api/fleet/agents/{agentId}/reassign
  • Path went from /agents/{agentId}/reassign to /api/fleet/agents/{agentId}/reassign (same operationId)
    Breaking
POST /api/fleet/agents/{agentId}/request_diagnostics
  • Path went from /agents/{agentId}/request_diagnostics to /api/fleet/agents/{agentId}/request_diagnostics (same operationId)
    Breaking
POST /api/fleet/agents/{agentId}/unenroll
  • Path went from /agents/{agentId}/unenroll to /api/fleet/agents/{agentId}/unenroll (same operationId)
    Breaking
POST /api/fleet/agents/{agentId}/upgrade
  • Path went from /agents/{agentId}/upgrade to /api/fleet/agents/{agentId}/upgrade (same operationId)
    Breaking
POST /api/fleet/enrollment-api-keys
  • Path went from /enrollment-api-keys to /api/fleet/enrollment-api-keys (same operationId)
POST /api/fleet/enrollment_api_keys
  • Path went from /enrollment_api_keys to /api/fleet/enrollment_api_keys (same operationId)
    Breaking
POST /api/fleet/epm/bulk_assets
  • Path went from /epm/bulk_assets to /api/fleet/epm/bulk_assets (same operationId)
    Breaking
POST /api/fleet/epm/packages
  • Path went from /epm/packages to /api/fleet/epm/packages (same operationId)
    Breaking
POST /api/fleet/epm/packages/_bulk
  • Path went from /epm/packages/_bulk to /api/fleet/epm/packages/_bulk (same operationId)
    Breaking
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Path went from /epm/packages/{pkgName}/{pkgVersion} to /api/fleet/epm/packages/{pkgName}/{pkgVersion} (same operationId)
    Breaking
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}/transforms/authorize
  • Path went from /epm/packages/{pkgName}/{pkgVersion}/transforms/authorize to /api/fleet/epm/packages/{pkgName}/{pkgVersion}/transforms/authorize (same operationId)
    Breaking
POST /api/fleet/epm/packages/{pkgkey}
  • Path went from /epm/packages/{pkgkey} to /api/fleet/epm/packages/{pkgkey} (same operationId)
POST /api/fleet/fleet_server_hosts
  • Path went from /fleet_server_hosts to /api/fleet/fleet_server_hosts (same operationId)
    Breaking
POST /api/fleet/health_check
  • Path went from /health_check to /api/fleet/health_check (same operationId)
    Breaking
POST /api/fleet/logstash_api_keys
  • Path went from /logstash_api_keys to /api/fleet/logstash_api_keys (same operationId)
    Breaking
POST /api/fleet/outputs
  • Path went from /outputs to /api/fleet/outputs (same operationId)
    Breaking
POST /api/fleet/package_policies
  • Path went from /package_policies to /api/fleet/package_policies (same operationId)
    Breaking
POST /api/fleet/package_policies/_bulk_get
  • Path went from /package_policies/_bulk_get to /api/fleet/package_policies/_bulk_get (same operationId)
    Breaking
POST /api/fleet/package_policies/delete
  • Path went from /package_policies/delete to /api/fleet/package_policies/delete (same operationId)
    Breaking
POST /api/fleet/package_policies/upgrade
  • Path went from /package_policies/upgrade to /api/fleet/package_policies/upgrade (same operationId)
    Breaking
POST /api/fleet/package_policies/upgrade/dryrun
  • Path went from /package_policies/upgrade/dryrun to /api/fleet/package_policies/upgrade/dryrun (same operationId)
    Breaking
POST /api/fleet/proxies
  • Path went from /proxies to /api/fleet/proxies (same operationId)
    Breaking
POST /api/fleet/service-tokens
  • Path went from /service-tokens to /api/fleet/service-tokens (same operationId)
POST /api/fleet/service_tokens
  • Path went from /service_tokens to /api/fleet/service_tokens (same operationId)
    Breaking
POST /api/fleet/setup
  • Path went from /setup to /api/fleet/setup (same operationId)
    Breaking
PUT /api/fleet/agent_download_sources/{sourceId}
  • Path went from /agent_download_sources/{sourceId} to /api/fleet/agent_download_sources/{sourceId} (same operationId)
    Breaking
PUT /api/fleet/agent_policies/{agentPolicyId}
  • Path went from /agent_policies/{agentPolicyId} to /api/fleet/agent_policies/{agentPolicyId} (same operationId)
    Breaking
PUT /api/fleet/agents/{agentId}
  • Path went from /agents/{agentId} to /api/fleet/agents/{agentId} (same operationId)
    Breaking
PUT /api/fleet/agents/{agentId}/reassign
  • Path went from /agents/{agentId}/reassign to /api/fleet/agents/{agentId}/reassign (same operationId)
PUT /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Path went from /epm/packages/{pkgName}/{pkgVersion} to /api/fleet/epm/packages/{pkgName}/{pkgVersion} (same operationId)
    Breaking
PUT /api/fleet/fleet_server_hosts/{itemId}
  • Path went from /fleet_server_hosts/{itemId} to /api/fleet/fleet_server_hosts/{itemId} (same operationId)
    Breaking
PUT /api/fleet/outputs/{outputId}
  • Path went from /outputs/{outputId} to /api/fleet/outputs/{outputId} (same operationId)
    Breaking
PUT /api/fleet/package_policies/{packagePolicyId}
  • Path went from /package_policies/{packagePolicyId} to /api/fleet/package_policies/{packagePolicyId} (same operationId)
    Breaking
PUT /api/fleet/proxies/{itemId}
  • Path went from /proxies/{itemId} to /api/fleet/proxies/{itemId} (same operationId)
    Breaking
PUT /api/fleet/settings
  • Path went from /settings to /api/fleet/settings (same operationId)
    Breaking
Removed 1 Breaking
GET /settings/enrollment
  • Removing a resource is always breaking unless it was deprecated before
    Breaking