Skip to content
43 changes: 7 additions & 36 deletions deploy-manage/cloud-organization/tools-and-apis.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,16 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud/current/ec-work-with-apis.html
navigation_title: Tools and APIs
---

# Tools and APIs [ec-work-with-apis]
# Tools and APIs for your Cloud organization [ec-work-with-apis]

Most Elastic resources can be accessed and managed through RESTful APIs. While the {{ecloud}} API is used to manage your deployments and their components, the Elasticsearch and Kibana APIs provide direct access to your data and your visualizations, respectively.

{{ecloud}} API
: You can use the {{ecloud}} API to manage your deployments and all of the resources associated with them. This includes performing deployment CRUD operations, scaling or autoscaling resources, and managing traffic filters, deployment extensions, remote clusters, and Elastic Stack versions. You can also access cost data by deployment and by organization.

To learn more about the {{ecloud}} API, read through the [API overview](cloud://reference/cloud-hosted/ec-api-restful.md), try out some [getting started examples](cloud://reference/cloud-hosted/ec-api-examples.md), and check our [API reference documentation](https://www.elastic.co/docs/api/doc/cloud).

Calls to the {{ecloud}} API are subject to [Rate limiting](cloud://reference/cloud-hosted/ec-api-rate-limiting.md).


Elasticsearch APIs
: This set of APIs allows you to interact directly with the Elasticsearch nodes in your deployment. You can ingest data, run search queries, check the health of your clusters, manage snapshots, and more.

To use these APIs on {{ecloud}} read our topic [Access the API console](cloud://reference/cloud-hosted/ec-api-console.md), and to learn about all of the available endpoints check the [Elasticsearch API reference documentation](elasticsearch://reference/elasticsearch/rest-apis/index.md).

Some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-elasticsearch) apply when using the Elasticsearch APIs on {{ecloud}}.


Kibana APIs
: Many Kibana features can be accessed through these APIs, including Kibana objects, patterns, and dashboards, as well as user roles and user sessions. You can use these APIs to configure alerts and actions, and to access health details for the Kibana Task Manager.

The Kibana APIs cannot be accessed directly from the {{ecloud}} Console; you need to use `curl` or another HTTP tool to connect. Check the [Kibana API reference documentation](https://www.elastic.co/guide/en/kibana/current/api.html) to learn about using the APIs and for details about all available endpoints.

Some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-kibana) apply when using these APIs with Kibana on {{ecloud}} as compared to an on-prem installation.


Other Products
: Most other Elastic products have APIs to support machine-to-machine operations. You can find the documentation for these at the following links:

* [APM event intake API Reference](/solutions/observability/apps/elastic-apm-events-intake-api.md)
* [App Search API Reference](https://www.elastic.co/guide/en/app-search/current/api-reference.html)
* [Elastic Security APIs](https://www.elastic.co/guide/en/security/current/security-apis.html)
* [Fleet APIs](/reference/fleet/fleet-api-docs.md)
* [Logstash APIs](https://www.elastic.co/guide/en/logstash/current/monitoring-logstash.html)
* [Workplace Search API Reference](https://www.elastic.co/guide/en/workplace-search/current/workplace-search-api-overview.html)
You can use the [{{ecloud}} API](https://www.elastic.co/docs/api/doc/cloud/) to manage your {{ecloud}} organization, members, costs, billing, and more.

* Refer to [](/deploy-manage/api-keys/elastic-cloud-api-keys.md) to learn how to generate an API key to access this API.
* Refer to [{{ecloud}} RESTful API](cloud://reference/cloud-hosted/ec-api-restful.md) for usage information and examples.

For {{ecloud}} [service status](/deploy-manage/cloud-organization/service-status.md) updates, you can use the [Service Status API](https://status.elastic.co/api/).

For information about all of the tools and APIs that you can use to manage your {{ech}} deployments and {{serverless-full}} projects, refer to [](/deploy-manage/deploy/elastic-cloud/tools-apis.md).
9 changes: 9 additions & 0 deletions deploy-manage/deploy/_snippets/cloud-api-console.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
With the {{es}} API console, you can interact with a specific {{es}} deployment directly from the {{ecloud}} Console or Cloud UI without having to authenticate again. This RESTful API access is limited to the specific cluster and works only for {{es}} API calls.

You can find this console in the {{ecloud}} Console or Cloud UI when selecting a specific deployment to manage. From the {{es}} menu, select **API Console**.

:::{note}
This API Console is different from the [Dev Tools Console](/explore-analyze/query-filter/tools/console.md) available in {{kib}}, from which you can call {{es}} and {{kib}} APIs. On the {{es}} API Console, you cannot run {{kib}} APIs.

This API console is intended for admin purposes. Avoid running normal workload like indexing or search requests.
:::
2 changes: 2 additions & 0 deletions deploy-manage/deploy/_snippets/core-apis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- [{{es}} APIs](https://www.elastic.co/docs/api/doc/elasticsearch/): This set of APIs allows you to interact directly with the {{es}} nodes in your deployment. You can ingest data, run search queries, check the health of your clusters, manage snapshots, and more.
- [{{kib}} APIs](https://www.elastic.co/docs/api/doc/kibana/): Many {{kib}} features can be accessed through these APIs, including {{kib}} objects, patterns, and dashboards, as well as user roles and user sessions. You can use these APIs to configure alerts and actions, and to access health details for the [{{kib}} Task Manager](/deploy-manage/distributed-architecture/kibana-tasks-management.md).
9 changes: 9 additions & 0 deletions deploy-manage/deploy/_snippets/ecctl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Elastic Cloud Control (ECCTL) is the command-line interface for {{ecloud}} APIs. It wraps typical operations commonly needed by operators within a single command line tool.

ECCTL provides the following benefits:

- Easier to use than the {{ecloud}} Console, Cloud UI, or using the RESTful API directly
- Helps you automate the deployment lifecycle
- Provides a foundation for integration with other tools

Find more details in the [ECCTL documentation](ecctl://reference/index.md).
5 changes: 5 additions & 0 deletions deploy-manage/deploy/_snippets/other-apis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Some other Elastic products have APIs to support machine-to-machine operations:

* [APM event intake API](/solutions/observability/apps/elastic-apm-events-intake-api.md)
* [Fleet APIs](/reference/fleet/fleet-api-docs.md)
* [Logstash APIs](logstash://reference/monitoring-logstash.md)
3 changes: 3 additions & 0 deletions deploy-manage/deploy/_snippets/tpec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
The {{ecloud}} Terraform provider allows you to provision and manage {{ech}} and {{ece}} deployments as code, and introduce DevOps-driven methodologies to manage and deploy the {{stack}} and solutions.

To get started, see the [{{ecloud}} Terraform provider documentation](https://registry.terraform.io/providers/elastic/ec/latest/docs).
61 changes: 40 additions & 21 deletions deploy-manage/deploy/cloud-enterprise/tools-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,63 @@ applies_to:
ece: all
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-api-console.html
navigation_title: "Tools and APIs"
---
# Tools and APIs
# Tools and APIs for {{ece}}

% What needs to be done: Write from scratch
Review key resources that can be used to interact with and manage your {{ece}} installation and deployments.

% GitHub issue: https://github.com/elastic/docs-projects/issues/310

⚠️ **This page is a work in progress.** ⚠️
## APIs

You can use these tools and APIs to interact with the following {{ece}} features:
You can use the following APIs in an {{ece}} environment.

* [{{ecloud}} Control (ecctl)](ecctl://reference/index.md): Wraps typical operations commonly needed by operators within a single command line tool.
* [ECE scripts](cloud://reference/cloud-enterprise/scripts.md): Use the `elastic-cloud-enterprise.sh` script to install {{ece}} or modify your installation.
* [ECE diagnostics tool](/troubleshoot/deployments/cloud-enterprise/run-ece-diagnostics-tool.md): Collect logs and metrics that you can send to Elastic Support for troubleshooting and investigation purposes.
* [Elasticsearch API console](#ece-api-console)
:::{tip}
Refer to [](/deploy-manage/api-keys.md) to learn how to generate API keys for your environment.
:::

**API**
### Orchestration APIs

% ECE API links and information are still pending
* [Elastic Cloud Enterprise RESTful API](cloud://reference/cloud-enterprise/restful-api.md)
You can use the [{{ece}} RESTful API](https://www.elastic.co/docs/api/doc/cloud-enterprise/) to manage both your {{stack}} deployments and the ECE platform.

## {{es}} API Console [ece-api-console]
Refer to [{{es}} API conventions](cloud://reference/cloud-enterprise/restful-api.md) 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](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md) to learn about headers and request body conventions, and to view examples.
:::

With the API console you can interact with a specific {{es}} deployment directly from the Cloud UI without having to authenticate again. This RESTful API access is limited to the specific cluster and works only for Elasticsearch API calls.
:::{include} /deploy-manage/deploy/_snippets/core-apis.md
:::

::::{important}
API console is intended for admin purposes. Avoid running normal workload like indexing or search requests.
::::
:::{include} /deploy-manage/deploy/_snippets/other-apis.md
:::

You can find this console in Cloud UI when selecting a specific deployment to manage. From the {{es}} menu, select **API Console**.
## {{es}} API Console [ece-api-console]

:::{note}
This API Console is different from the [Dev Tools Console](/explore-analyze/query-filter/tools/console.md) available in {{kib}}, from which you can call {{es}} and {{kib}} APIs. On the ECE API Console, you cannot run Kibana APIs.
:::{include} /deploy-manage/deploy/_snippets/cloud-api-console.md
:::

To learn more about what kinds of {{es}} API calls you can make from the Cloud UI, check the [Elasticsearch API Reference](elasticsearch://reference/elasticsearch/rest-apis/index.md) documentation.
## Elastic Cloud Control: command-line interface for {{ecloud}}

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

## Provision hosted deployments with Terraform
```{applies_to}
deployment:
ess: ga
serverless: unavailable
```

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

## Other tools

* [ECE scripts](cloud://reference/cloud-enterprise/scripts.md): Use these scripts to install {{ece}} or modify your installation.
* [ECE diagnostics tool](/troubleshoot/deployments/cloud-enterprise/run-ece-diagnostics-tool.md): Collect logs and metrics that you can send to Elastic Support for troubleshooting and investigation purposes.

Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ To deploy a simple [{{kib}}](/get-started/the-stack.md#stack-components-kibana)
```


For a full description of each `CustomResourceDefinition` (CRD), refer to the [*API Reference*](cloud-on-k8s://reference/api-docs.md) or view the CRD files in the [project repository](https://github.com/elastic/cloud-on-k8s/tree/2.16/config/crds). You can also retrieve information about a CRD from the instance. For example, describe the {{kib}} CRD specification with [`describe`](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_describe/):
For a full description of each `CustomResourceDefinition` (CRD), refer to the [API reference](cloud-on-k8s://reference/api-docs.md) or view the CRD files in the [project repository](https://github.com/elastic/cloud-on-k8s/tree/2.16/config/crds). You can also retrieve information about a CRD from the instance. For example, describe the {{kib}} CRD specification with [`describe`](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_describe/):

```sh
kubectl describe crd kibana
Expand Down
40 changes: 35 additions & 5 deletions deploy-manage/deploy/cloud-on-k8s/tools-apis.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,41 @@
# Tools and APIs
---
applies_to:
deployment:
eck: all
navigation_title: "Tools and APIs"
---

% What needs to be done: Write from scratch
# Tools and APIs for {{eck}}

% GitHub issue: https://github.com/elastic/docs-projects/issues/310
Review key resources that can be used to interact with and manage your {{eck}} operator and deployments.

⚠️ **This page is a work in progress.** ⚠️
## APIs

You can use these tools and APIs to interact with the following {{eck}} features:
You can use the following APIs in an {{eck}} environment.

:::{tip}
Refer to [](/deploy-manage/api-keys.md) to learn how to generate API keys for your environment.
:::

### Orchestration APIs

You can use the [{{eck}} API](cloud-on-k8s://reference/api-docs.md) to create and manage {{stack}} components using Elastic-provided [Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions).


### 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 {{eck}} deployments.

:::{tip}
Refer to [{{es}} API conventions](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md) 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
:::

## Tools

* [ECK diagnostics tool](/troubleshoot/deployments/cloud-on-k8s/run-eck-diagnostics.md): Use the `eck-diagnostics` command line tool to create a diagnostic archive to help troubleshoot issues with ECK.
Loading
Loading