Skip to main content
Previewv1.2.1
62 actions · 1 auth method
InfrastructureIAM

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

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 (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

62 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).
Upgrade Deployment
Upgrade a deployment to a new Elastic Stack version.
List Extensions
Get a list of all custom extensions (plugins and bundles).
Create Extension
Create a new custom extension (plugin or bundle) for Elasticsearch deployments.
Get Extension
Get details of a specific extension by its ID.
Update Extension
Update an extension’s metadata by its ID.
Delete Extension
Delete a custom extension by its ID.
Get Unified Credentials
Get the current Elastic Cloud connection’s unified credentials and identity.
List Unified Organizations
List unified organizations in Elastic Cloud.
Get Unified Organization
Get a unified Elastic Cloud organization by ID.
List Unified Resource Types
List unified resource types in Elastic Cloud.
List Unified Resource Users
List unified users with access to a specific Elastic Cloud deployment or project.
List Unified Roles
List unified roles in Elastic Cloud.
Get Unified Role
Get a unified Elastic Cloud role by ID.
List Unified Users
List unified users in Elastic Cloud.
Get Unified User
Get a unified Elastic Cloud organization member by ID.
Delete Unified User
Delete a unified Elastic Cloud organization member by ID.
Start Resource Instances
Start all instances of a deployment resource (elasticsearch, kibana, apm, or integrations_server).
Stop Resource Instances
Stop all instances of a deployment resource (elasticsearch, kibana, apm, or integrations_server).
Cancel Pending Plan
Cancel the pending plan for a deployment resource (elasticsearch, kibana, apm, or integrations_server).
Get Elasticsearch Keystore
Get the keystore items for an Elasticsearch resource.
Update Elasticsearch Keystore
Add or remove items from the Elasticsearch keystore for a deployment.
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.
Delete Organization Invitations
Delete one or more pending invitations for 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 by their user ID.
Remove Role Assignments
Remove role assignments from a user by their user ID.
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 with name, type, region, and rules.
Get Traffic Filter Ruleset
Get details of a specific traffic filter ruleset by its ID.
Update Traffic Filter Ruleset
Update an existing traffic filter ruleset by its ID.
Delete Traffic Filter Ruleset
Delete a traffic filter ruleset by its ID.
Get Associated Deployments
Get the deployments associated with a traffic filter ruleset by its ID.
Create Ruleset Association
Link a traffic filter ruleset to a deployment by ruleset ID.
Delete Ruleset Association
Unlink a traffic filter ruleset from a deployment by ruleset ID, association type, and entity ID.
Get Associated Rulesets
Get the traffic filter rulesets associated with a specific deployment by its ID.