Security Solution API Playground (ESS)

4 days ago

Change #b1091703

1.0.2

Compare

6 structure changes including:

6 Additions

Added 6

DELETE /api/endpoint_list/items

GET /api/endpoint_list/items

GET /api/endpoint_list/items/_find

POST /api/endpoint_list

POST /api/endpoint_list/items

PUT /api/endpoint_list/items

4 days ago

Change #dfcc464e

1.0.2

Breaking

Compare

135 structure changes including:

102 Breaking changes

15 Additions

104 Modifications

16 Removals

Modified 104 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
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - diff property Modified
    - policy_id property Modified
      - Type went from string to string | null

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/actions/{actionId}/cancel

Path went from `/agents/actions/{actionId}/cancel` to `/api/fleet/agents/actions/{actionId}/cancel` (same operationId)
Breaking

POST /api/fleet/agents

Path went from `/agents` to `/api/fleet/agents` (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
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - item property Modified
    - package_policies property Modified
Query
format query parameter Added

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/_bulk_get

Path went from `/agent_policies/_bulk_get` to `/api/fleet/agent_policies/_bulk_get` (same operationId)
Breaking
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - items property Modified
    - package_policies property Modified
Query
format query parameter Added

POST /api/fleet/agent_policies

Path went from `/agent_policies` to `/api/fleet/agent_policies` (same operationId)
Breaking
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - item property Modified
    - package_policies 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/endpoint/action/kill_process

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Endpoint_Management_API_KillOrSuspendActionSchema alternative Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- Security_Solution_Endpoint_Management_API_KillProcessRouteRequestBody alternative Added

GET /api/fleet/uninstall_tokens/{uninstallTokenId}

Path went from `/uninstall_tokens/{uninstallTokenId}` to `/api/fleet/uninstall_tokens/{uninstallTokenId}` (same operationId)
Breaking

GET /api/fleet/uninstall_tokens

Path went from `/uninstall_tokens` to `/api/fleet/uninstall_tokens` (same operationId)
Breaking

GET /api/fleet/settings

Path went from `/settings` to `/api/fleet/settings` (same operationId)
Breaking

GET /api/fleet/proxies/{itemId}

Path went from `/proxies/{itemId}` to `/api/fleet/proxies/{itemId}` (same operationId)
Breaking

GET /api/fleet/proxies

Path went from `/proxies` to `/api/fleet/proxies` (same operationId)
Breaking

GET /api/fleet/package_policies/{packagePolicyId}

Path went from `/package_policies/{packagePolicyId}` to `/api/fleet/package_policies/{packagePolicyId}` (same operationId)
Breaking
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - item property Modified
    - policy_id property Modified
      - Type went from string to string | null

GET /api/fleet/package_policies

Path went from `/package_policies` to `/api/fleet/package_policies` (same operationId)
Breaking
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - items property Modified
    - policy_id property Modified
      - Type went from string to string | null

GET /api/fleet/outputs/{outputId}/health

Path went from `/outputs/{outputId}/health` to `/api/fleet/outputs/{outputId}/health` (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

Path went from `/outputs` to `/api/fleet/outputs` (same operationId)
Breaking

GET /api/fleet/kubernetes

Path went from `/kubernetes` to `/api/fleet/kubernetes` (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/fleet_server_hosts

Path went from `/fleet_server_hosts` to `/api/fleet/fleet_server_hosts` (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/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/packages/{pkgkey}

Path went from `/epm/packages/{pkgkey}` to `/api/fleet/epm/packages/{pkgkey}` (same operationId)

GET /api/fleet/agent-status

Path went from `/agent-status` to `/api/fleet/agent-status` (same operationId)

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/delete

Path went from `/package_policies/delete` to `/api/fleet/package_policies/delete` (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
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - items property Modified
    - policy_id property Modified
      - Type went from string to string | null

POST /api/fleet/package_policies

Path went from `/package_policies` to `/api/fleet/package_policies` (same operationId)
Breaking
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
    - policy_id property Modified
      - Type went from string to string | null

POST /api/fleet/outputs

Path went from `/outputs` to `/api/fleet/outputs` (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/health_check

Path went from `/health_check` to `/api/fleet/health_check` (same operationId)
Breaking

POST /api/fleet/fleet_server_hosts

Path went from `/fleet_server_hosts` to `/api/fleet/fleet_server_hosts` (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/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/{pkgName}/{pkgVersion}

Path went from `/epm/packages/{pkgName}/{pkgVersion}` to `/api/fleet/epm/packages/{pkgName}/{pkgVersion}` (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

Path went from `/epm/packages` to `/api/fleet/epm/packages` (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/enrollment_api_keys

Path went from `/enrollment_api_keys` to `/api/fleet/enrollment_api_keys` (same operationId)
Breaking
Body
application/json; Elastic-Api-Version=2023-10-31 content type Added

POST /api/fleet/enrollment-api-keys

Path went from `/enrollment-api-keys` to `/api/fleet/enrollment-api-keys` (same operationId)

POST /api/fleet/agents/{agentId}/upgrade

Path went from `/agents/{agentId}/upgrade` to `/api/fleet/agents/{agentId}/upgrade` (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}/request_diagnostics

Path went from `/agents/{agentId}/request_diagnostics` to `/api/fleet/agents/{agentId}/request_diagnostics` (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}/actions

Path went from `/agents/{agentId}/actions` to `/api/fleet/agents/{agentId}/actions` (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/bulk_upgrade

Path went from `/agents/bulk_upgrade` to `/api/fleet/agents/bulk_upgrade` (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_unenroll

Path went from `/agents/bulk_unenroll` to `/api/fleet/agents/bulk_unenroll` (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

DELETE /api/fleet/proxies/{itemId}

Path went from `/proxies/{itemId}` to `/api/fleet/proxies/{itemId}` (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/outputs/{outputId}

Path went from `/outputs/{outputId}` to `/api/fleet/outputs/{outputId}` (same operationId)
Breaking

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/epm/packages/{pkgkey}

Path went from `/epm/packages/{pkgkey}` to `/api/fleet/epm/packages/{pkgkey}` (same operationId)

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/enrollment_api_keys/{keyId}

Path went from `/enrollment_api_keys/{keyId}` to `/api/fleet/enrollment_api_keys/{keyId}` (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/agents/{agentId}

Path went from `/agents/{agentId}` to `/api/fleet/agents/{agentId}` (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/agent_download_sources/{sourceId}

Path went from `/agent_download_sources/{sourceId}` to `/api/fleet/agent_download_sources/{sourceId}` (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
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - item property Modified
    - package_policies property Modified
Query
format query parameter Added

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
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
    - policy_id property Modified
      - Type went from string to string | null

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

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/{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}/stats

Path went from `/epm/packages/{pkgName}/stats` to `/api/fleet/epm/packages/{pkgName}/stats` (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

Path went from `/epm/packages` to `/api/fleet/epm/packages` (same operationId)
Breaking

GET /api/fleet/epm/categories

Path went from `/epm/categories` to `/api/fleet/epm/categories` (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/enrollment_api_keys

Path went from `/enrollment_api_keys` to `/api/fleet/enrollment_api_keys` (same operationId)
Breaking
Query
perPage, page, kuery query parameters Added

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)

GET /api/fleet/data_streams

Path went from `/data_streams` to `/api/fleet/data_streams` (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/agents/{agentId}

Path went from `/agents/{agentId}` to `/api/fleet/agents/{agentId}` (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/setup

Path went from `/agents/setup` to `/api/fleet/agents/setup` (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/action_status

Path went from `/agents/action_status` to `/api/fleet/agents/action_status` (same operationId)
Breaking

GET /api/fleet/agents

Path went from `/agents` to `/api/fleet/agents` (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/agent_status

Path went from `/agent_status` to `/api/fleet/agent_status` (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_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}

Path went from `/agent_policies/{agentPolicyId}` to `/api/fleet/agent_policies/{agentPolicyId}` (same operationId)
Breaking
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - item property Modified
    - package_policies property Modified
Query
format query parameter Added

GET /api/fleet/agent_policies

Path went from `/agent_policies` to `/api/fleet/agent_policies` (same operationId)
Breaking
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - items property Modified
    - package_policies property Modified
Query
format query parameter Added

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_download_sources

Path went from `/agent_download_sources` to `/api/fleet/agent_download_sources` (same operationId)
Breaking

Removed 16 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 /settings/enrollment

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

POST /api/actions/connector/{connectorId}

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

PUT /api/actions/action/{actionId}

PUT /api/actions/connector/{connectorId}

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

Added 15

PUT /api/actions/connector/{id}

PUT /api/actions/action/{id}

POST /api/risk_score/engine/schedule_now

POST /api/actions/connector/{id}/_execute

POST /api/actions/connector/{id}

POST /api/actions/action/{id}/_execute

POST /api/actions/action

GET /api/actions/list_action_types

GET /api/actions/connectors

GET /api/actions/connector_types

GET /api/actions/connector/{id}

GET /api/actions/action/{id}

GET /api/actions

DELETE /api/actions/connector/{id}

DELETE /api/actions/action/{id}

25 days ago

Change #352f56b1

1.0.2

Breaking

Compare

158 structure changes including:

2 Breaking changes

156 Additions

1 Modification

1 Removal

Modified 1 Breaking

GET /api/asset_criticality/list

Verb went from `POST` to `GET` (same operationId)
Breaking

Removed 1 Breaking

GET /api/status

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

Added 156

GET /settings

POST /agents/{agentId}/actions

POST /agents/{agentId}/reassign

POST /agents/{agentId}/request_diagnostics

POST /agents/{agentId}/unenroll

POST /agents/{agentId}/upgrade

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/alerts/alert/{alertId}

POST /api/alerts/alert/{alertId}/_disable

POST /api/alerts/alert/{alertId}/_enable

POST /api/alerts/alert/{alertId}/_mute_all

POST /api/alerts/alert/{alertId}/_unmute_all

POST /api/alerts/alert/{alertId}/alert_instance/{alertInstanceId}/_mute

GET /settings/enrollment

GET /uninstall_tokens

GET /uninstall_tokens/{uninstallTokenId}

PATCH /api/cases

PATCH /api/cases/configure/{configurationId}

PATCH /api/cases/{caseId}/comments

POST /agent_download_sources

POST /agent_policies

POST /agent_policies/_bulk_get

POST /agent_policies/delete

POST /agent_policies/{agentPolicyId}/copy

POST /agents

POST /agents/actions/{actionId}/cancel

POST /agents/bulk_reassign

POST /agents/bulk_request_diagnostics

POST /agents/bulk_unenroll

POST /agents/bulk_update_agent_tags

POST /agents/bulk_upgrade

POST /agents/setup

POST /package_policies/delete

POST /package_policies/upgrade

POST /package_policies/upgrade/dryrun

POST /proxies

POST /service-tokens

POST /service_tokens

POST /setup

PUT /agent_download_sources/{sourceId}

PUT /agent_policies/{agentPolicyId}

PUT /agents/{agentId}

PUT /agents/{agentId}/reassign

PUT /api/alerting/rule/{id}

PUT /api/alerts/alert/{alertId}

PUT /epm/packages/{pkgName}/{pkgVersion}

PUT /fleet_server_hosts/{itemId}

PUT /outputs/{outputId}

PUT /package_policies/{packagePolicyId}

PUT /proxies/{itemId}

PUT /settings

POST /api/alerts/alert/{alertId}/alert_instance/{alertInstanceId}/_unmute

POST /api/cases

POST /api/cases/configure

POST /api/cases/{caseId}/comments

POST /api/cases/{caseId}/connector/{connectorId}/_push

POST /enrollment-api-keys

POST /enrollment_api_keys

POST /epm/bulk_assets

POST /epm/packages

POST /epm/packages/_bulk

POST /epm/packages/{pkgName}/{pkgVersion}

POST /epm/packages/{pkgName}/{pkgVersion}/transforms/authorize

POST /epm/packages/{pkgkey}

POST /fleet_server_hosts

POST /health_check

POST /logstash_api_keys

POST /outputs

POST /package_policies

POST /package_policies/_bulk_get

GET /agent_policies/{agentPolicyId}

GET /agent_policies/{agentPolicyId}/download

GET /agent_policies/{agentPolicyId}/full

GET /agent_status

GET /agent_status/data

GET /agents

GET /agents/action_status

GET /agents/files/{fileId}/{fileName}

GET /agents/setup

GET /agents/tags

GET /agents/{agentId}

GET /agents/{agentId}/uploads

GET /api/alerting/_health

GET /api/alerting/rule/{id}

GET /api/alerting/rule_types

GET /api/alerting/rules/_find

GET /api/alerts/alert/{alertId}

GET /api/alerts/alerts/_find

GET /api/alerts/alerts/_health

GET /enrollment_api_keys/{keyId}

DELETE /agent_download_sources/{sourceId}

DELETE /agents/files/{fileId}

DELETE /agents/{agentId}

DELETE /api/alerting/rule/{id}

DELETE /api/alerts/alert/{alertId}

DELETE /api/cases

DELETE /api/cases/{caseId}/comments

DELETE /api/cases/{caseId}/comments/{commentId}

DELETE /enrollment-api-keys/{keyId}

DELETE /enrollment_api_keys/{keyId}

DELETE /epm/packages/{pkgName}/{pkgVersion}

DELETE /epm/packages/{pkgkey}

DELETE /fleet_server_hosts/{itemId}

DELETE /outputs/{outputId}

DELETE /package_policies/{packagePolicyId}

DELETE /proxies/{itemId}

GET /agent-status

GET /agent_download_sources

GET /agent_download_sources/{sourceId}

GET /agent_policies

GET /epm/categories

GET /epm/packages

GET /epm/packages/limited

GET /epm/packages/{pkgName}/stats

GET /epm/packages/{pkgName}/{pkgVersion}

GET /epm/packages/{pkgName}/{pkgVersion}/{filePath}

GET /epm/packages/{pkgkey}

GET /epm/templates/{pkgName}/{pkgVersion}/inputs

GET /epm/verification_key_id

GET /fleet_server_hosts

GET /fleet_server_hosts/{itemId}

GET /kubernetes

GET /outputs

GET /outputs/{outputId}

GET /outputs/{outputId}/health

GET /package_policies

GET /package_policies/{packagePolicyId}

GET /proxies

GET /proxies/{itemId}

GET /api/alerts/alerts/list_alert_types

GET /api/cases/_find

GET /api/cases/alerts/{alertId}

GET /api/cases/configure

GET /api/cases/configure/connectors/_find

GET /api/cases/reporters

GET /api/cases/status

GET /api/cases/tags

GET /api/cases/{caseId}

GET /api/cases/{caseId}/alerts

GET /api/cases/{caseId}/comments

GET /api/cases/{caseId}/comments/_find

GET /api/cases/{caseId}/comments/{commentId}

GET /api/cases/{caseId}/user_actions

GET /api/cases/{caseId}/user_actions/_find

GET /api/status

GET /data_streams

GET /enrollment-api-keys

GET /enrollment-api-keys/{keyId}

GET /enrollment_api_keys

Aug 13, 2024

Change #7888369a

1.0.2

Breaking

Compare

100 structure changes including:

6 Breaking changes

66 Additions

28 Modifications

6 Removals

Modified 28 Breaking

GET /api/endpoint/action/{action_id}

Path
query path parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
action_id path parameter Added

GET /api/endpoint/action/{action_id}/file/{file_id}/download`

Path
query path parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
action_id, file_id path parameters Added

GET /api/endpoint/action/{action_id}/file/{file_id}`

Path
query path parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
action_id, file_id path parameters Added

GET /api/endpoint/action_status

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

GET /api/endpoint/metadata/{id}

Path
query path parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
id path parameter Added

GET /api/endpoint/policy/summaries

Operation is now deprecated

PATCH /api/detection_engine/rules

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Detections_API_EsqlRulePatchProps alternative Modified
  - response_actions 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
  - Security_Solution_Detections_API_EsqlRuleResponseFields alternative Modified

PATCH /api/detection_engine/rules/_bulk_update

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Detections_API_EsqlRulePatchProps alternative Modified
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - Security_Solution_Detections_API_EsqlRuleResponseFields alternative Modified

POST /api/detection_engine/rules

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Detections_API_EsqlRuleCreateFields alternative Modified
  - response_actions 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
  - Security_Solution_Detections_API_EsqlRuleResponseFields alternative Modified

POST /api/detection_engine/rules/_bulk_create

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Detections_API_EsqlRuleCreateFields alternative Modified
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - Security_Solution_Detections_API_EsqlRuleResponseFields alternative Modified

POST /api/detection_engine/rules/_bulk_delete

Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - Security_Solution_Detections_API_EsqlRuleResponseFields alternative Modified

POST /api/detection_engine/rules/preview

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Detections_API_RulePreviewParams alternative Modified
  - response_actions property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - data_view_id, event_category_override, filters, index, tiebreaker_field, timestamp_field properties Added
- Security_Solution_Detections_API_RulePreviewParams alternative Modified
  - language, query properties Modified
    - Properties are no longer required
  - data_view_id, filters, index, saved_id properties Added
- Security_Solution_Detections_API_RulePreviewParams alternative Modified
  - query, language properties Modified
    - Properties are no longer required
  - saved_id, data_view_id, filters, index properties Added
- Security_Solution_Detections_API_RulePreviewParams alternative Modified
  - alert_suppression property Modified
  - language property Modified
    - Property is no longer required
  - response_actions property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - threshold, data_view_id, filters, index, saved_id properties Added
- Security_Solution_Detections_API_RulePreviewParams alternative Modified
  - language property Modified
    - Property is no longer required
  - response_actions property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - 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_Solution_Detections_API_RulePreviewParams alternative Modified
  - response_actions, language, query properties Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - anomaly_threshold, machine_learning_job_id properties Added
- Security_Solution_Detections_API_RulePreviewParams alternative Modified
  - language property Modified
    - Property is no longer required
  - response_actions property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking
  - history_window_start, new_terms_fields, data_view_id, filters, index properties Added
- Security_Solution_Detections_API_RulePreviewParams alternative Modified
  - response_actions property Removed
    - Removing a resource is always breaking unless it was deprecated before
      Breaking

POST /api/endpoint/action/execute

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Endpoint_Management_API_ExecuteActionRequestBody alternative Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- Security_Solution_Endpoint_Management_API_ExecuteRouteRequestBody alternative Added

POST /api/endpoint/action/get_file

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Endpoint_Management_API_GetFileActionRequestBody alternative Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- Security_Solution_Endpoint_Management_API_GetFileRouteRequestBody alternative Added

POST /api/endpoint/action/kill_process

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Endpoint_Management_API_ProcessActionSchemas alternative Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- Security_Solution_Endpoint_Management_API_KillOrSuspendActionSchema alternative Added

POST /api/endpoint/action/scan

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Endpoint_Management_API_ScanActionRequestBody alternative Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- Security_Solution_Endpoint_Management_API_ScanRouteRequestBody alternative Added

POST /api/endpoint/action/suspend_process

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Endpoint_Management_API_ProcessActionSchemas alternative Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- Security_Solution_Endpoint_Management_API_KillOrSuspendActionSchema alternative Added

POST /api/endpoint/action/upload

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Endpoint_Management_API_FileUploadActionRequestBody alternative Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- Security_Solution_Endpoint_Management_API_UploadRouteRequestBody alternative Added

POST /api/endpoint/isolate

Operation is now deprecated
Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- endpoint_ids property Modified
  - Property is now required
    Breaking
  - endpoint_ids property Modified
    - Property is now required
      Breaking
- agent_type property Added

POST /api/endpoint/unisolate

Operation is now deprecated
Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- endpoint_ids property Modified
  - Property is now required
    Breaking
  - endpoint_ids property Modified
    - Property is now required
      Breaking
- agent_type property Added

PUT /api/detection_engine/rules

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Detections_API_EsqlRuleCreateFields alternative Modified
  - response_actions 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
  - Security_Solution_Detections_API_EsqlRuleResponseFields alternative Modified

PUT /api/detection_engine/rules/_bulk_update

Body
application/json; Elastic-Api-Version=2023-10-31 content type Modified
- Security_Solution_Detections_API_EsqlRuleCreateFields alternative Modified
Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - Security_Solution_Detections_API_EsqlRuleResponseFields alternative Modified

GET /api/endpoint/action/state

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

GET /api/endpoint/action

Query
query query parameter Modified

GET /api/detection_engine/rules/_find

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

GET /api/detection_engine/rules

Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - Security_Solution_Detections_API_EsqlRuleResponseFields alternative Modified

DELETE /api/detection_engine/rules/_bulk_delete

Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - Security_Solution_Detections_API_EsqlRuleResponseFields alternative Modified

DELETE /api/detection_engine/rules

Response
200 response Modified
- application/json; Elastic-Api-Version=2023-10-31 content type Modified
  - Security_Solution_Detections_API_EsqlRuleResponseFields alternative Modified

Removed 6 Breaking

GET /api/endpoint/action_log/{agent_id}

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

POST /api/detection_engine/rules/_bulk_action

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

POST /api/endpoint/action/isolate

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

POST /api/endpoint/action/running_procs

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

POST /api/endpoint/action/unisolate

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

POST /api/security_ai_assistant/anonymization_fields/_bulk_action

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

Added 66

POST /api/saved_objects/_import

POST /api/saved_objects/_resolve_import_errors

POST /api/saved_objects/{type}

POST /api/saved_objects/{type}/{id}

POST /api/security_ai_assistant/anonymization_fields/_bulk_action

POST /api/security_ai_assistant/prompts/_bulk_action

POST /s/{spaceId}/api/observability/slos

POST /s/{spaceId}/api/observability/slos/_delete_instances

POST /s/{spaceId}/api/observability/slos/{sloId}/_reset

POST /s/{spaceId}/api/observability/slos/{sloId}/disable

POST /s/{spaceId}/api/observability/slos/{sloId}/enable

PUT /api/actions/action/{actionId}

PUT /api/actions/connector/{connectorId}

PUT /api/data_views/data_view/{viewId}/runtime_field

PUT /api/saved_objects/{type}/{id}

PUT /s/{spaceId}/api/observability/slos/{sloId}

POST /api/actions

GET /s/{spaceId}/api/observability/slos/{sloId}

GET /s/{spaceId}/api/observability/slos

GET /api/status

GET /api/saved_objects/{type}/{id}

GET /api/saved_objects/resolve/{type}/{id}

GET /api/saved_objects/_find

GET /api/ml/saved_objects/sync

GET /api/endpoint/action_log/{agent_id}

GET /api/data_views/default

GET /api/data_views/data_view/{viewId}/runtime_field/{fieldName}

GET /api/data_views/data_view/{viewId}

GET /api/data_views

GET /api/apm/services/{serviceName}/annotation/search

GET /api/actions/list_action_types

GET /api/actions/connectors

GET /api/actions/connector_types

GET /api/actions/connector/{connectorId}

GET /api/actions/action/{actionId}

GET /api/actions

DELETE /s/{spaceId}/api/observability/slos/{sloId}

DELETE /api/data_views/data_view/{viewId}/runtime_field/{fieldName}

DELETE /api/data_views/data_view/{viewId}

DELETE /api/actions/connector/{connectorId}

DELETE /api/actions/action/{actionId}

POST /api/saved_objects/_export

POST /api/saved_objects/_bulk_update

POST /api/saved_objects/_bulk_resolve

POST /api/saved_objects/_bulk_get

POST /api/saved_objects/_bulk_delete

POST /api/saved_objects/_bulk_create

POST /api/endpoint/action/unisolate

POST /api/endpoint/action/running_procs

POST /api/endpoint/action/isolate

POST /api/encrypted_saved_objects/_rotate_key

POST /api/detection_engine/rules/_bulk_action

POST /api/data_views/swap_references/_preview

POST /api/data_views/swap_references

POST /api/data_views/default

POST /api/data_views/data_view/{viewId}/runtime_field/{fieldName}

POST /api/data_views/data_view/{viewId}/runtime_field

POST /api/data_views/data_view/{viewId}/fields

POST /api/data_views/data_view/{viewId}

POST /api/data_views/data_view

POST /api/apm/services/{serviceName}/annotation

POST /api/apm/agent_keys

POST /api/actions/connector/{connectorId}/_execute

POST /api/actions/connector/{connectorId}

POST /api/actions/connector

POST /api/actions/action/{actionId}/_execute

Aug 7, 2024

Change #b9406690

1.0.2

Compare

Do not miss any Security Solution API Playground (ESS) changes, ever again

Changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API documentation has been created