Skip to content

tools-apis.md

Latest commit

 

History

History
118 lines (80 loc) · 4.79 KB

tools-apis.md

File metadata and controls

118 lines (80 loc) · 4.79 KB
Raw
navigation_title Tools and APIs
mapped_pages
applies_to
deployment serverless
ess
ga
ga
products
id
cloud-serverless
id
cloud-terraform

Tools and APIs for {{ecloud}}

Review key resources that can be used to interact with and manage your {{ecloud}} organization, {{ech}} deployments, and {{serverless-full}} projects.

APIs

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

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

Orchestration APIs

The following REST APIs allow you to manage your {{ecloud}} organization, users, security, billing and resources.

Area API Tasks
{{ecloud}} organization

{{ech}} deployments		 {{ecloud}} API Manage your Cloud organization, members, costs, billing, and more.

Manage your hosted deployments and all of the resources associated with them, including scaling or autoscaling resources, and managing network security, deployment extensions, remote clusters, and {{stack}} versions.

Refer to {{ecloud}} RESTful API for usage information and examples.
{{serverless-full}} projects {{serverless-full}} API Manage {{serverless-full}} projects.
{{ecloud}} services Service Status API Programmatically ingest service status updates.
{{ecloud}} billing information Cloud Billing API Retrieve additional billing and cost information about your {{ecloud}} organization.

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 {{ech}} deployments and {{serverless-full}} projects. Separate APIs are used for {{ech}} and {{serverless-full}}.

Note that some restrictions apply when using these APIs on {{ecloud}}.

:::{tip} Refer to {{es}} API conventions to learn about headers, request body conventions, and examples for {{es-serverless}} and {{es}} REST APIs. :::

:::::{applies-switch}

::::{applies-item} serverless:

The following APIs are available for {{es-serverless}} users:

Version reporting [serverless-tools-apis-version-reporting]

:::{include} /deploy-manage/deploy/_snippets/serverless-version-reporting.md ::: ::::

::::{applies-item} ess:

The following APIs are available for {{ech}} users:

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

APIs for optional products

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

{{ecloud}} API console

deployment:
  ess: ga
serverless: unavailable

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

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

deployment:
  ess: ga
serverless: unavailable

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

Provision projects and deployments with Terraform

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

Elastic Cloud email service

{{ecloud}} provides a built-in email service used by the preconfigured email connector, available in both {{ech}} deployments and {{serverless-full}} projects. This service can be used to send alert notifications and is also supported in {{ech}} by Watcher.

Email service limits

The following quotas apply to both {{ech}} deployments and {{serverless-full}} projects when using the Elastic email service:

  • Email sending quota: 500 emails per 15 minute period.
  • Maximum number of recipients per message: 30 recipients per email (To, CC, and BCC all count as recipients).
  • Maximum message size (including attachments): 10 MB per message (after Base64 encoding).
  • The email-sender can't be customized (Any custom From: header will be removed).