Skip to content

tools-apis.md

Latest commit

 

History

History
68 lines (47 loc) · 2.27 KB

tools-apis.md

File metadata and controls

68 lines (47 loc) · 2.27 KB
Raw
navigation_title Tools and APIs
mapped_pages
applies_to
deployment
ece
all
products
id
cloud-enterprise

Tools and APIs for {{ece}}

Review key resources that can be used to interact with and manage your {{ece}} installation and deployments.

APIs

You can use the following APIs in an {{ece}} environment.

:::{tip} Refer to to learn how to generate API keys for your environment. :::

Orchestration APIs

You can use the {{ece}} RESTful API to manage both your {{stack}} deployments and the ECE platform.

Refer to {{es}} API conventions to learn about headers and request body conventions, and view examples.

APIs to interact with data and solution features

The following APIs allow you to interact with your {{es}} cluster, its data, and the features available to you in your {{ece}} deployments.

:::{tip} Refer to {{es}} API conventions to learn about headers and request body conventions, and to view examples. :::

:::{include} /deploy-manage/deploy/_snippets/core-apis.md :::

:::{include} /deploy-manage/deploy/_snippets/other-apis.md :::

{{es}} API Console [ece-api-console]

:::{include} /deploy-manage/deploy/_snippets/cloud-api-console.md :::

{{ecloud}} Control: command-line interface for {{ecloud}}

:::{include} /deploy-manage/deploy/_snippets/ecctl.md :::

Provision hosted deployments with Terraform

deployment:
  ess: ga
serverless: unavailable

:::{include} /deploy-manage/deploy/_snippets/tpec.md :::

Other tools

  • ECE scripts: Use these scripts to install {{ece}} or modify your installation.
  • ECE diagnostics tool: Collect logs and metrics related to your ECE installation that you can send to Elastic Support for troubleshooting and investigation purposes.
  • {{es}} Support Diagnostic tool: Captures a point-in-time snapshot of cluster statistics and most {{es}} settings for troubleshooting purposes.