View as Markdown
Elastic Cloud icon

Elastic Cloud ACTION

Update Deployment

Update an existing Elastic Cloud deployment, including resizing cluster capacity. Cluster resize is performed here by supplying updated resources sizing (no separate resize action exists). Run List Deployments first to find the deployment ID. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Elastic Cloud account once, then configure and run Update Deployment from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "elastic_cloud-update-deployment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    elastic_cloud: { authProvisionId: "apn_xxxxxxx" },
    deploymentId: "Deployment ID",
    resources: "Resources",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Update Deployment inputs
Property Type Description
deploymentId Deployment ID string
The ID of the deployment (e.g. abc123def456). Run the List Deployments action first to obtain valid deployment IDs.
Required
resources Resources string
JSON object describing the updated resource topology; used for general updates and for cluster resizing. Example (resize to 4096 MB memory across 2 zones): {"elasticsearch":[{"region":"gcp-us-central1","plan":{"cluster_topology":[{"size":{"value":4096,"resource":"memory"},"zone_count":2}]}}]}. Note: region and version live inside each resource sub-object, not at the top level of the update body.
Optional
name Name string
Optional new human-readable name for the deployment.
Optional
pruneOrphans Prune Orphans boolean
Whether to shut down deployment resources that are not referenced in this update request. Resources are tracked by their ref_id. Set to true only when the resources you supply are the complete, authoritative definition of the deployment — anything omitted (e.g. an existing Kibana or APM resource) is shut down, though it can be restored from its latest snapshot afterwards. Defaults to false, which leaves omitted resources intact and is the safe choice for partial updates.
Optional
metadata Metadata string
JSON object of deployment metadata. Example: {"tags":[{"key":"env","value":"prod"}]}
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
elastic_cloud-update-deployment
Version
0.0.2
App
Elastic Cloud
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes