> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Elastic Cloud

> How to set up the Elastic Cloud connector, plus the actions that are available.

![Elastic Cloud](https://stackone-logos.com/api/elastic/filled/svg)

v2.0.2[See changelog](https://docs.stackone.com/connectors/elasticcloud/changelog.md)

[62 actions](#actions) · 1 auth method

Infrastructure
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/elasticcloud/guides/connector-profile/api-key.md)
>
> Generate a Cloud API key from your Elastic Cloud Organization settings. Organization owner access is required.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/elasticcloud/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

62 actions

ActionDescription

Get Account`elasticcloud_get_account`

Get the current account information.

Update Account`elasticcloud_update_account`

Update the current account trust settings.

List Deployments`elasticcloud_list_deployments`

Get a list of all deployments in the Elastic Cloud organization.

Get Deployment`elasticcloud_get_deployment`

Get detailed information about a specific deployment.

Create Deployment`elasticcloud_create_deployment`

Create a new Elastic Cloud deployment.

Update Deployment`elasticcloud_update_deployment`

Update an existing Elastic Cloud deployment.

Shut Down Deployment`elasticcloud_shutdown_deployment`

Shut down an Elastic Cloud deployment and all its resources.

Restore Shut Down Deployment`elasticcloud_restore_deployment`

Restore a previously shut down Elastic Cloud deployment.

Search Deployments`elasticcloud_search_deployments`

Search for deployments using Elasticsearch-style queries.

Get Deployment Templates`elasticcloud_get_deployment_templates`

Get a list of available deployment templates for a specific region.

Get The Tags For A Deployment`elasticcloud_get_deployment_tags`

Get the tags associated with a deployment.

Set The Tags For A Deployment`elasticcloud_set_deployment_tags`

Set tags on a deployment (replaces all existing tags).

Upgrade Deployment`elasticcloud_upgrade_deployment`

Upgrade a deployment to a new Elastic Stack version.

List Extensions`elasticcloud_list_extensions`

Get a list of all custom extensions (plugins and bundles).

Create Extension`elasticcloud_create_extension`

Create a new custom extension (plugin or bundle) for Elasticsearch deployments.

Get Extension`elasticcloud_get_extension`

Get details of a specific extension by its ID.

Update Extension`elasticcloud_update_extension`

Update an extension's metadata by its ID.

Delete Extension`elasticcloud_delete_extension`

Delete a custom extension by its ID.

Get Unified Credentials`elasticcloud_unified_get_me`

Get the current Elastic Cloud connection's unified credentials and identity.

List Unified Organizations`elasticcloud_unified_list_organizations`

List unified organizations in Elastic Cloud.

Get Unified Organization`elasticcloud_unified_get_organization`

Get a unified Elastic Cloud organization by ID.

List Unified Resource Types`elasticcloud_unified_list_resource_types`

List unified resource types in Elastic Cloud.

List Unified Resource Users`elasticcloud_unified_list_resource_users`

List unified users with access to a specific Elastic Cloud deployment or project.

List Unified Roles`elasticcloud_unified_list_roles`

List unified roles in Elastic Cloud.

Get Unified Role`elasticcloud_unified_get_role`

Get a unified Elastic Cloud role by ID.

List Unified Users`elasticcloud_unified_list_users`

List unified users in Elastic Cloud.

Get Unified User`elasticcloud_unified_get_user`

Get a unified Elastic Cloud organization member by ID.

Delete Unified User`elasticcloud_unified_delete_user`

Delete a unified Elastic Cloud organization member by ID.

Start Resource Instances`elasticcloud_start_resource_instances`

Start all instances of a deployment resource (elasticsearch, kibana, apm, or integrations\_server).

Stop Resource Instances`elasticcloud_stop_resource_instances`

Stop all instances of a deployment resource (elasticsearch, kibana, apm, or integrations\_server).

Cancel Pending Plan`elasticcloud_cancel_pending_plan`

Cancel the pending plan for a deployment resource (elasticsearch, kibana, apm, or integrations\_server).

Get Elasticsearch Keystore`elasticcloud_get_keystore`

Get the keystore items for an Elasticsearch resource.

Update Elasticsearch Keystore`elasticcloud_update_keystore`

Add or remove items from the Elasticsearch keystore for a deployment.

List Organizations`elasticcloud_list_organizations`

Get a list of all organizations the current user belongs to.

Get Organization`elasticcloud_get_organization`

Get details of a specific organization.

List Organization Members`elasticcloud_list_organization_members`

Get a list of all members in an organization.

List Organization Invitations`elasticcloud_list_organization_invitations`

Get a list of pending invitations for an organization.

Send Organization Invitations`elasticcloud_send_invitations`

Send invitations to join an organization.

Delete Organization Invitations`elasticcloud_delete_organization_invitations`

Delete one or more pending invitations for an organization.

Remove Organization Members`elasticcloud_remove_members`

Remove one or more members from an organization.

Get Remote Clusters`elasticcloud_get_remote_clusters`

Get the certificate-based remote clusters configured for an Elasticsearch resource.

Set Remote Clusters`elasticcloud_set_remote_clusters`

Configure certificate-based remote clusters for an Elasticsearch resource.

Get Deployment Elasticsearch Resource`elasticcloud_get_deployment_elasticsearch_resource`

Get information about an Elasticsearch resource within a deployment.

Restart Deployment Elasticsearch Resource`elasticcloud_restart_deployment_elasticsearch_resource`

Restart the Elasticsearch resource within a deployment.

Get Deployment Kibana Resource`elasticcloud_get_deployment_kibana_resource`

Get information about a Kibana resource within a deployment.

Get Upgrade Assistant Status`elasticcloud_get_upgrade_assistant_status`

Get the upgrade readiness status for a deployment.

Get Trusted Environments`elasticcloud_get_trusted_environments`

Get the trusted environments for the organization.

Add Role Assignments`elasticcloud_add_role_assignments`

Add role assignments to a user by their user ID.

Remove Role Assignments`elasticcloud_remove_role_assignments`

Remove role assignments from a user by their user ID.

List Attached Snapshot Repositories`elasticcloud_list_attached_snapshot_repositories`

Get the snapshot repositories attached to an Elasticsearch resource.

Create Snapshot Repository For Elasticsearch Resource`elasticcloud_create_snapshot_repository_for_elasticsearch_resource`

Link a snapshot repository from a source deployment.

Remove Snapshot Repository From Elasticsearch Resource`elasticcloud_remove_snapshot_repository`

Remove a snapshot repository from an Elasticsearch resource.

Get Stack Versions`elasticcloud_get_stack_versions`

Get a list of available Elastic Stack versions.

List Traffic Filter Rulesets`elasticcloud_list_traffic_filter_rulesets`

Get a list of all traffic filter rulesets.

Create Traffic Filter Ruleset`elasticcloud_create_traffic_filter_ruleset`

Create a new traffic filter ruleset with name, type, region, and rules.

Get Traffic Filter Ruleset`elasticcloud_get_traffic_filter_ruleset`

Get details of a specific traffic filter ruleset by its ID.

Update Traffic Filter Ruleset`elasticcloud_update_traffic_filter_ruleset`

Update an existing traffic filter ruleset by its ID.

Delete Traffic Filter Ruleset`elasticcloud_delete_traffic_filter_ruleset`

Delete a traffic filter ruleset by its ID.

Get Associated Deployments`elasticcloud_get_associated_deployments`

Get the deployments associated with a traffic filter ruleset by its ID.

Create Ruleset Association`elasticcloud_create_ruleset_association`

Link a traffic filter ruleset to a deployment by ruleset ID.

Delete Ruleset Association`elasticcloud_delete_ruleset_association`

Unlink a traffic filter ruleset from a deployment by ruleset ID, association type, and entity ID.

Get Associated Rulesets`elasticcloud_get_associated_rulesets`

Get the traffic filter rulesets associated with a specific deployment by its ID.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.