Skip to main content
Elastic Cloud
Elastic Cloud
50 actions · 1 auth method
Preview

​
Authentication

API Key

Generate a Cloud API key from your Elastic Cloud Organization settings. Organization owner access is required.Guides: Connector Profile, Link Account
Actions
50 actions
Action
Description
Get Account
Get the current account information.
Update Account
Update the current account trust settings.
List Deployments
Get a list of all deployments in the Elastic Cloud organization.
Get Deployment
Get detailed information about a specific deployment.
Create Deployment
Create a new Elastic Cloud deployment.
Update Deployment
Update an existing Elastic Cloud deployment.
Shut Down Deployment
Shut down an Elastic Cloud deployment and all its resources.
Restore Shut Down Deployment
Restore a previously shut down Elastic Cloud deployment.
Search Deployments
Search for deployments using Elasticsearch-style queries.
Get Deployment Templates
Get a list of available deployment templates for a specific region.
Get The Tags For A Deployment
Get the tags associated with a deployment.
Set The Tags For A Deployment
Set tags on a deployment (replaces all existing tags).
List Extensions
Get a list of all custom extensions (plugins and bundles).
Create Extension
Create a new custom extension (plugin or bundle).
Get Extension
Get details of a specific extension.
Update Extension
Update an extension’s metadata.
Delete Extension
Delete a custom extension.
Start Resource Instances
Start all instances of a deployment resource.
Stop Resource Instances
Stop all instances of a deployment resource.
Cancel Pending Plan
Cancel the pending plan for a deployment resource.
Get Elasticsearch Keystore
Get the keystore items for an Elasticsearch resource.
Update Elasticsearch Keystore
Add or remove items from the Elasticsearch keystore.
List Organizations
Get a list of all organizations the current user belongs to.
Get Organization
Get details of a specific organization.
List Organization Members
Get a list of all members in an organization.
List Organization Invitations
Get a list of pending invitations for an organization.
Send Organization Invitations
Send invitations to join an organization.
Remove Organization Members
Remove one or more members from an organization.
Get Remote Clusters
Get the certificate-based remote clusters configured for an Elasticsearch resource.
Set Remote Clusters
Configure certificate-based remote clusters for an Elasticsearch resource.
Get Deployment Elasticsearch Resource
Get information about an Elasticsearch resource within a deployment.
Restart Deployment Elasticsearch Resource
Restart the Elasticsearch resource within a deployment.
Get Deployment Kibana Resource
Get information about a Kibana resource within a deployment.
Get Upgrade Assistant Status
Get the upgrade readiness status for a deployment.
Get Trusted Environments
Get the trusted environments for the organization.
Add Role Assignments
Add role assignments to a user.
Remove Role Assignments
Remove role assignments from a user.
List Attached Snapshot Repositories
Get the snapshot repositories attached to an Elasticsearch resource.
Create Snapshot Repository For Elasticsearch Resource
Link a snapshot repository from a source deployment.
Remove Snapshot Repository From Elasticsearch Resource
Remove a snapshot repository from an Elasticsearch resource.
Get Stack Versions
Get a list of available Elastic Stack versions.
List Traffic Filter Rulesets
Get a list of all traffic filter rulesets.
Create Traffic Filter Ruleset
Create a new traffic filter ruleset.
Get Traffic Filter Ruleset
Get details of a specific traffic filter ruleset.
Update Traffic Filter Ruleset
Update an existing traffic filter ruleset.
Delete Traffic Filter Ruleset
Delete a traffic filter ruleset.
Get Associated Deployments
Get the deployments associated with a traffic filter ruleset.
Create Ruleset Association
Link a traffic filter ruleset to a deployment.
Delete Ruleset Association
Unlink a traffic filter ruleset from a deployment.
Get Associated Rulesets
Get the traffic filter rulesets associated with a specific deployment.

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/elastic/filled/png

Connector Profile

Elastic Cloud - API Key
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/elastic/filled/png

Link Account

Elastic Cloud - API Key
4

Use Actions

Invoke actions using one of the methods below: