Change Updates

Do not miss any Elastic Cloud API changes, ever again

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

RSS

19 days ago

main
1
Compare

API structure has changed

This documentation update aligns with the March 2025 release. Check out the release notes.

NOTE: The "Api key authentication method Removed" messages in the change summary are just a change in the way the API is documented, not in the way it is used.

103 structure changes including:
103 Modifications
Modified 103 Breaking
DELETE /deployments/extensions/{extension_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /deployments/traffic-filter/rulesets/{ruleset_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /organizations/{organization_id}/domains
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /organizations/{organization_id}/idp
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /organizations/{organization_id}/invitations/{invitation_tokens}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /organizations/{organization_id}/members/{user_ids}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /organizations/{organization_id}/role_mappings
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /users/auth/keys
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /users/auth/keys/{api_key_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /users/{user_id}/role_assignments
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /account
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /billing/costs/{organization_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /billing/costs/{organization_id}/charts
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /billing/costs/{organization_id}/deployments
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /billing/costs/{organization_id}/deployments/{deployment_id}/charts
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /billing/costs/{organization_id}/deployments/{deployment_id}/items
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /billing/costs/{organization_id}/items
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/extensions
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/extensions/{extension_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/templates
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/templates/{template_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/traffic-filter/associations/{association_type}/{associated_entity_id}/rulesets
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/traffic-filter/link-ids
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/traffic-filter/rulesets
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/traffic-filter/rulesets/{ruleset_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/traffic-filter/rulesets/{ruleset_id}/associations
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}/apm/{ref_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}/appsearch/{ref_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}/certificate-authority
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}/elasticsearch/{ref_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}/elasticsearch/{ref_id}/keystore
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}/enterprise_search/{ref_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}/integrations_server/{ref_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}/kibana/{ref_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}/migrate_template
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /deployments/{deployment_id}/upgrade_assistant/status
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • target_version query parameter Added
GET /organizations
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /organizations/invitations/{invitation_token}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /organizations/{organization_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /organizations/{organization_id}/domains
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /organizations/{organization_id}/idp
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /organizations/{organization_id}/idp/metadata.xml
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /organizations/{organization_id}/invitations
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /organizations/{organization_id}/members
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /organizations/{organization_id}/role_mappings
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /stack/versions
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /trusted-environments
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /users/auth/keys
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /users/auth/keys/{api_key_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PATCH /account
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PATCH /deployments/{deployment_id}/elasticsearch/{ref_id}/keystore
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/_search
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/eligible-remote-clusters
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/extensions
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/extensions/{extension_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/traffic-filter/link-ids/_claim
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/traffic-filter/link-ids/_unclaim
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/traffic-filter/rulesets
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/traffic-filter/rulesets/{ruleset_id}/associations
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/_restore
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/_shutdown
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/apm/{ref_id}/_reset-token
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_restart
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_stop
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_stop
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_upgrade
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /organizations/invitations/{invitation_token}/_accept
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /organizations/{organization_id}/domains/_generate_verification_code
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /organizations/{organization_id}/domains/_verify
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /organizations/{organization_id}/invitations
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /users/auth/keys
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /users/{user_id}/role_assignments
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /account
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /deployments/extensions/{extension_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /deployments/traffic-filter/rulesets/{ruleset_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /deployments/{deployment_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /organizations/{organization_id}
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /organizations/{organization_id}/idp
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /organizations/{organization_id}/role_mappings
  • Authentication
  • Api key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking