Elastic Cloud API

3 days ago

Change #f3585002

Breaking

Compare

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

15 structure changes including:

1 Breaking change

14 Modifications

1 Removal

Modified 14

GET /deployments/templates

Response
200 response Modified
- application/json content type Modified
  - deployment_template property Modified
    - resources property Modified

GET /deployments/templates/{template_id}

Response
200 response Modified
- application/json content type Modified
  - deployment_template property Modified
    - resources property Modified

GET /deployments/{deployment_id}

Response
200 response Modified
- application/json content type Modified
  - resources property Modified
    - kibana, apm, enterprise_search, integrations_server properties Modified

GET /deployments/{deployment_id}/apm/{ref_id}

Response
200 response Modified
- application/json content type Modified
  - info property Modified
    - plan_info property Modified

GET /deployments/{deployment_id}/enterprise_search/{ref_id}

Response
200 response Modified
- application/json content type Modified
  - info property Modified
    - plan_info property Modified

GET /deployments/{deployment_id}/integrations_server/{ref_id}

Response
200 response Modified
- application/json content type Modified
  - info property Modified
    - plan_info property Modified

GET /deployments/{deployment_id}/kibana/{ref_id}

Response
200 response Modified
- application/json content type Modified
  - info property Modified
    - plan_info property Modified

GET /deployments/{deployment_id}/migrate_template

Response
200 response Modified
- application/json content type Modified
  - resources property Modified
    - kibana, apm, enterprise_search, integrations_server properties Modified

GET /stack/versions

Response
200 response Modified
- application/json content type Modified
  - stacks property Modified
    - rolling_upgrade_compatible_versions property Added

POST /deployments

Body
application/json content type Modified
- resources property Modified
  - kibana property Modified
    - plan property Modified
  - apm property Modified
    - plan property Modified
  - enterprise_search property Modified
    - plan property Modified
  - integrations_server property Modified
    - plan property Modified

POST /deployments/_search

Response
200 response Modified
- application/json content type Modified
  - deployments property Modified
    - resources property Modified

POST /deployments/eligible-remote-clusters

Response
200 response Modified
- application/json content type Modified
  - deployments property Modified
    - resources property Modified

POST /deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters

Response
200 response Modified
- application/json content type Modified
  - deployments property Modified
    - resources property Modified

PUT /deployments/{deployment_id}

Body
application/json content type Modified
- resources property Modified
  - kibana property Modified
    - plan property Modified
  - apm property Modified
    - plan property Modified
  - enterprise_search property Modified
    - plan property Modified
  - integrations_server property Modified
    - plan property Modified

Removed 1 Breaking

POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_upgrade

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

21 days ago

Change #7f4e219a

Breaking

Compare

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

Feb 13, 2025

Change #a61d201d

Compare

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

11 structure changes including:

11 Additions

Added 11

DELETE /organizations/{organization_id}/domains

DELETE /organizations/{organization_id}/idp

DELETE /organizations/{organization_id}/role_mappings

GET /organizations/{organization_id}/domains

GET /organizations/{organization_id}/idp

GET /organizations/{organization_id}/idp/metadata.xml

GET /organizations/{organization_id}/role_mappings

POST /organizations/{organization_id}/domains/_generate_verification_code

POST /organizations/{organization_id}/domains/_verify

PUT /organizations/{organization_id}/idp

PUT /organizations/{organization_id}/role_mappings

Nov 25, 2024

Change #896e5236

Compare

This documentation update aligns with the following release: https://www.elastic.co/guide/en/cloud/current/ec-release-notes-2024-11-21.html

1 structure change including:

1 Modification

Modified 1

GET /deployments/{deployment_id}

Query
show_instance_metrics query parameter Added

Nov 5, 2024

Change #e53d0e74

Compare

6 structure changes including:

6 Modifications

Modified 6

GET /billing/costs/{organization_id}

Operation is now deprecated

GET /billing/costs/{organization_id}/charts

Operation is now deprecated

GET /billing/costs/{organization_id}/deployments

Operation is now deprecated

GET /billing/costs/{organization_id}/deployments/{deployment_id}/charts

Operation is now deprecated

GET /billing/costs/{organization_id}/deployments/{deployment_id}/items

Operation is now deprecated

GET /billing/costs/{organization_id}/items

Operation is now deprecated

Nov 1, 2024

Change #bfc14f1a

Compare

This documentation update aligns with the release summarized in https://www.elastic.co/guide/en/cloud/current/ec-release-notes-2024-10-31.html

6 structure changes including:

6 Modifications

Modified 6

GET /organizations

Response
200 response Modified
- content type Modified
  - organizations property Modified
    - sso_login_identifier property Added

GET /organizations/invitations/{invitation_token}

Response
200 response Modified
- content type Modified
  - organization property Modified
    - sso_login_identifier property Added

GET /organizations/{organization_id}

Response
200 response Modified
- content type Modified
  - sso_login_identifier property Added

GET /organizations/{organization_id}/invitations

Response
200 response Modified
- content type Modified
  - invitations property Modified
    - organization property Modified

POST /organizations/{organization_id}/invitations

Response
201 response Modified
- content type Modified
  - invitations property Modified
    - organization property Modified

PUT /organizations/{organization_id}

Response
200 response Modified
- content type Modified
  - sso_login_identifier property Added

Sep 20, 2024

Change #c800e047

Compare

This documentation update aligns with the September 2024 release described in https://www.elastic.co/guide/en/cloud/current/ec-release-notes-2024-09-19.html

8 structure changes including:

8 Modifications

Modified 8

GET /deployments/templates

Response
200 response Modified
- content type Modified
  - deployment_template property Modified
    - settings property Modified

GET /deployments/templates/{template_id}

Response
200 response Modified
- content type Modified
  - deployment_template property Modified
    - settings property Modified

GET /deployments/{deployment_id}

Response
200 response Modified
- content type Modified
  - settings property Modified
    - solution_type property Added

POST /deployments

Body
content type Modified
- settings property Modified
  - solution_type property Added

POST /deployments/_search

Response
200 response Modified
- content type Modified
  - deployments property Modified
    - settings property Modified

POST /deployments/eligible-remote-clusters

Response
200 response Modified
- content type Modified
  - deployments property Modified
    - settings property Modified

POST /deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters

Response
200 response Modified
- content type Modified
  - deployments property Modified
    - settings property Modified

PUT /deployments/{deployment_id}

Response
200 response Modified
- content type Modified
  - settings property Modified
    - solution_type property Added

Sep 3, 2024

Change #bd80c3d1

Compare

Do not miss any Elastic Cloud API changes, ever again

Changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API documentation has been created