Elastic Cloud Enterprise API

9 days ago

Change #3832a089

Breaking

Compare

This documentation update aligns with ECE 4.0.0. Check out the release notes.

62 structure changes including:

3 Breaking changes

14 Additions

45 Modifications

3 Removals

Modified 45 Breaking

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
  - settings property Modified
    - auto_ops property Added

GET /deployments/{deployment_id}/upgrade_assistant/status

Query
target_version query parameter Added

GET /organizations

Response
200 response Modified
- application/json content type Modified
  - organizations property Modified
    - sso_login_identifier property Added

GET /organizations/invitations/{invitation_token}

Response
200 response Modified
- application/json content type Modified
  - organization property Modified
    - sso_login_identifier property Added
  - role_assignments property Added

GET /organizations/{organization_id}

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

GET /organizations/{organization_id}/invitations

Response
200 response Modified
- application/json content type Modified
  - invitations property Modified
    - organization property Modified
    - role_assignments property Added

GET /organizations/{organization_id}/members

Response
200 response Modified
- application/json content type Modified
  - members property Modified
    - role_assignments property Added

GET /platform/configuration/templates/deployments/global

Response
204 response Added

GET /stack/versions

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

GET /stack/versions/{version}

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

GET /users/auth/keys

Response
200 response Modified
- application/json content type Modified
  - keys property Modified
    - role_assignments property Added

GET /users/auth/keys/_all

Response
200 response Modified
- application/json content type Modified
  - keys property Modified
    - role_assignments property Added

GET /users/auth/keys/{api_key_id}

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

GET /users/auth/saml/_init

Query
realm query parameter Added

GET /users/{user_id}/auth/keys

Response
200 response Modified
- application/json content type Modified
  - keys property Modified
    - role_assignments property Added

GET /users/{user_id}/auth/keys/{api_key_id}

Response
200 response Modified
- application/json content type Modified
  - role_assignments 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
- settings property Modified
  - solution_type property Added

POST /deployments/_search

Body
application/json content type Modified
- _source property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- cursor property Added
Response
200 response Modified
- application/json content type Modified
  - deployments property Modified
    - resources, settings, metadata properties Modified
  - minimal_metadata, cursor properties Added
Query
minimal_metadata query parameter Added

POST /deployments/eligible-remote-clusters

Body
application/json content type Modified
- _source property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- cursor property Added
Response
200 response Modified
- application/json content type Modified
  - deployments property Modified
    - resources, settings, metadata properties Modified
  - minimal_metadata, cursor properties Added

POST /deployments/templates

Body
application/json content type Modified
- deployment_template property Modified
  - resources property Modified
    - kibana, apm, enterprise_search, integrations_server properties Modified
  - settings property Modified
    - solution_type property Added

PUT /stack/versions/{version}

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

PUT /organizations/{organization_id}

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

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
- settings property Modified
  - auto_ops property Added
Response
200 response Modified
- application/json content type Modified
  - settings property Added

PUT /deployments/templates/{template_id}

Body
application/json content type Modified
- deployment_template property Modified
  - resources property Modified
    - kibana, apm, enterprise_search, integrations_server properties Modified
  - settings property Modified
    - solution_type property Added

POST /users/auth/keys

Body
application/json content type Modified
- role_assignments property Added
Response
201 response Modified
- application/json content type Modified
  - role_assignments property Added

POST /stack/versions

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

POST /platform/infrastructure/runners/_search

Body
application/json content type Modified
- _source property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- cursor property Added

POST /platform/infrastructure/allocators/_search

Body
application/json content type Modified
- _source property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- cursor property Added

POST /organizations/{organization_id}/invitations

Body
application/json content type Modified
- role_assignments property Added
Response
201 response Modified
- application/json content type Modified
  - invitations property Modified
    - organization property Modified
    - role_assignments property Added

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

Body
application/json content type Modified
- _source property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- cursor property Added
Response
200 response Modified
- application/json content type Modified
  - deployments property Modified
    - resources, settings, metadata properties Modified
  - minimal_metadata, cursor properties Added

POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password

Query
check_completion query parameter Added

DELETE /platform/configuration/instances/{id}

Query
only_test_version query parameter Added

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

GET /deployments/templates

Response
200 response Modified
- application/json content type Modified
  - deployment_template property Modified
    - resources, settings properties Modified
Query
hide_deprecated query parameter Added

GET /deployments/templates/{template_id}

Response
200 response Modified
- application/json content type Modified
  - deployment_template property Modified
    - resources, settings properties 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
  - settings property Modified
    - auto_ops, solution_type properties Added
  - metadata property Modified
    - byok_enabled property Added
Query
show_instance_metrics query parameter Added

Removed 3 Breaking

DELETE /deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/dependency/{resource_id}

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

GET /deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/dependency

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

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

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

Added 14

PUT /organizations/{organization_id}/role_mappings

PUT /organizations/{organization_id}/idp

POST /users/{user_id}/role_assignments

POST /organizations/{organization_id}/domains/_verify

POST /organizations/{organization_id}/domains/_generate_verification_code

PATCH /deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw

GET /organizations/{organization_id}/role_mappings

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

GET /organizations/{organization_id}/idp

GET /organizations/{organization_id}/domains

DELETE /users/{user_id}/role_assignments

DELETE /organizations/{organization_id}/role_mappings

DELETE /organizations/{organization_id}/idp

DELETE /organizations/{organization_id}/domains

Oct 29, 2024

Change #d0da4b01

Compare

This API documentation release aligns with Elastic Cloud Enterprise 3.7.3

Do not miss any Elastic Cloud Enterprise API changes, ever again

Changelog

Elastic Cloud Enterprise 4.0.0 documentation

API documentation has been created