# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elastic Cloud Enterprise Deployments API
  version: 1.0.0
extends: openapi/elk-stack-deployments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 72
- target: $.paths['/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List all deployments
      effect: read
      questions:
      - What deployments do I have running in Elastic Cloud Enterprise?
      - Can I see every deployment in my environment at once?
      instructions:
      - text: List all my deployments.
      - text: Show me every deployment I currently have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new deployment
      effect: write
      questions:
      - How do I spin up a new Elastic deployment?
      - Can I build a new deployment from a deployment template?
      - Is there a way to dry-run a deployment definition without actually creating it?
      instructions:
      - text: Create a new deployment named {name} from template {template_id}.
        slots:
          name: requestBody.name
          template_id: query.template_id
      - text: Create a deployment called {name} on stack version {version}.
        slots:
          name: requestBody.name
          version: requestBody.version
      - text: Validate a new deployment definition named {name} without creating it.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/_resync'].post
  update:
    x-apievangelist-phrasing:
      intent: Resync the search index for all deployments
      effect: write
      questions:
      - How do I rebuild the deployment search index across every deployment?
      - Can I skip deployments whose indexed version already matches during a full resync?
      instructions:
      - text: Resynchronize the search index for all deployments.
      - text: Resync every deployment's index entry, skipping ones already on the matching version.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/_search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search deployments with a query
      effect: read
      questions:
      - How do I find deployments that match a specific query?
      - Can I page and sort through deployment search results?
      instructions:
      - text: Search my deployments using query {query}.
        slots:
          query: requestBody.query
      - text: Find deployments matching {query} and return the first {size} results.
        slots:
          query: requestBody.query
          size: requestBody.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/eligible-remote-clusters'].post
  update:
    x-apievangelist-phrasing:
      intent: Find deployments eligible as remote clusters
      effect: read
      questions:
      - Which deployments can serve as remote clusters for a given Elasticsearch version?
      - How do I find candidate remote clusters compatible with version 8.x across all deployments?
      instructions:
      - text: List deployments with remote clusters eligible for version {version}.
        slots:
          version: query.version
      - text: Find remote cluster candidates compatible with Elasticsearch {version} matching {query}.
        slots:
          version: query.version
          query: requestBody.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's details
      effect: read
      questions:
      - How do I look up the full details of one deployment?
      - Can I include plan history and instance metrics when fetching a deployment?
      instructions:
      - text: Get details for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Show deployment {deployment_id} including its plan history.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a deployment's configuration
      effect: write
      questions:
      - How do I change the configuration of an existing deployment?
      - Can I rename a deployment and prune resources I left out of the update?
      instructions:
      - text: Rename deployment {deployment_id} to {name}.
        slots:
          deployment_id: path.deployment_id
          name: requestBody.name
      - text: Update deployment {deployment_id} with prune orphans set to {prune_orphans}.
        slots:
          deployment_id: path.deployment_id
          prune_orphans: requestBody.prune_orphans
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deployment and its resources
      effect: destructive
      questions:
      - How do I permanently delete a deployment along with all its resources?
      - Can I remove a deployment I no longer need entirely?
      instructions:
      - text: Delete deployment {deployment_id} and all of its resources.
        slots:
          deployment_id: path.deployment_id
      - text: Permanently remove deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/_restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a shut-down deployment
      effect: write
      questions:
      - How do I bring back a whole deployment that was shut down?
      - Can I restore every resource in a deployment from the latest snapshot?
      instructions:
      - text: Restore shut-down deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Restore all resources in deployment {deployment_id} from snapshot.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/_resync'].post
  update:
    x-apievangelist-phrasing:
      intent: Resync the search index for one deployment
      effect: write
      questions:
      - How do I force a single deployment's search index entry to resynchronize now?
      - Can I refresh the indexed record for just one deployment?
      instructions:
      - text: Resynchronize the search index for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Immediately resync deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/_shutdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Shut down an entire deployment
      effect: destructive
      questions:
      - How do I shut down every resource in a deployment?
      - Can I hide a deployment when I shut it down?
      instructions:
      - text: Shut down deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Shut down all resources in deployment {deployment_id} and hide it.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/apm/{ref_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's APM resource info
      effect: read
      questions:
      - How do I see the details of the APM resource in my deployment?
      - Can I view the APM resource's plan and settings?
      instructions:
      - text: Get APM resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Show the APM resource {ref_id} settings for deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/apm/{ref_id}/_reset-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset an APM resource's secret token
      effect: write
      questions:
      - How do I rotate the APM secret token for a deployment?
      - Can I generate a new secret token for my APM server?
      instructions:
      - text: Reset the APM secret token for resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Rotate the APM token on deployment {deployment_id}, resource {ref_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/appsearch/{ref_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's App Search resource info
      effect: read
      questions:
      - How do I see the details of the App Search resource in a deployment?
      - Can I include the plan log for my App Search resource?
      instructions:
      - text: Get App Search resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Show App Search resource {ref_id} of deployment {deployment_id} with plan logs.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode'].get
  update:
    x-apievangelist-phrasing:
      intent: Check App Search read-only status
      effect: read
      questions:
      - Is my App Search resource currently in read-only mode?
      - How can I check whether App Search writes are blocked?
      instructions:
      - text: Check whether App Search resource {ref_id} in deployment {deployment_id} is read-only.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Get the read-only status of App Search on deployment {deployment_id}, resource {ref_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn App Search read-only mode on or off
      effect: write
      questions:
      - How do I put App Search into read-only mode?
      - Can I switch App Search back to accepting writes?
      instructions:
      - text: Set App Search read-only mode to {enabled} for resource {ref_id} in deployment {deployment_id}.
        slots:
          enabled: requestBody.enabled
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Enable read-only mode on App Search resource {ref_id} of deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/certificate-authority'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's certificate authority
      effect: read
      questions:
      - Which certificate authority signs my deployment's certificates?
      - How do I download the CA certificate for a deployment?
      instructions:
      - text: Get the certificate authority for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Fetch the CA used to sign certificates on deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's Elasticsearch resource info
      effect: read
      questions:
      - How do I see the details of the Elasticsearch cluster inside a deployment?
      - Can I include system alerts and security settings for the Elasticsearch resource?
      instructions:
      - text: Get Elasticsearch resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Show system alerts for Elasticsearch resource {ref_id} of deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr'].post
  update:
    x-apievangelist-phrasing:
      intent: Migrate Elasticsearch and Kibana to enable CCR
      effect: write
      questions:
      - How do I enable cross-cluster replication on an existing deployment?
      - Can I validate a CCR migration before running it?
      instructions:
      - text: Enable cross-cluster replication for Elasticsearch resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Validate the CCR migration for deployment {deployment_id}, resource {ref_id}, without applying it.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm'].post
  update:
    x-apievangelist-phrasing:
      intent: Migrate an Elasticsearch resource to ILM
      effect: write
      questions:
      - How do I switch an Elasticsearch cluster over to index lifecycle management?
      - Which index patterns do I need to supply when migrating to ILM?
      instructions:
      - text: Migrate Elasticsearch resource {ref_id} in deployment {deployment_id} to ILM for index patterns {index_patterns}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
          index_patterns: requestBody.index_patterns
      - text: Turn on index lifecycle management for deployment {deployment_id} resource {ref_id} covering {index_patterns}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
          index_patterns: requestBody.index_patterns
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm'].post
  update:
    x-apievangelist-phrasing:
      intent: Migrate an Elasticsearch resource to SLM
      effect: write
      questions:
      - How do I move a cluster's snapshots onto snapshot lifecycle management?
      - Can I check that an SLM migration would succeed before doing it?
      instructions:
      - text: Migrate Elasticsearch resource {ref_id} in deployment {deployment_id} to SLM.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Validate switching deployment {deployment_id} resource {ref_id} to snapshot lifecycle management.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset the elastic superuser password
      effect: write
      questions:
      - I lost the elastic user password — how do I reset it?
      - Can I generate a new password for the built-in elastic superuser?
      instructions:
      - text: Reset the elastic user password for resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Generate a new elastic superuser password on deployment {deployment_id}, cluster {ref_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart'].post
  update:
    x-apievangelist-phrasing:
      intent: Restart a deployment's Elasticsearch cluster
      effect: write
      questions:
      - How do I restart the Elasticsearch cluster in a deployment?
      - Can I restart Elasticsearch one availability zone at a time?
      - Will restarting cancel a pending plan on the cluster?
      instructions:
      - text: Restart Elasticsearch resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Restart Elasticsearch {ref_id} on deployment {deployment_id} grouped by {group_attribute}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
          group_attribute: query.group_attribute
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Shut down a deployment's Elasticsearch cluster
      effect: destructive
      questions:
      - How do I shut down only the Elasticsearch cluster of a deployment?
      - Can I skip the snapshot when shutting down Elasticsearch?
      instructions:
      - text: Shut down Elasticsearch resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Shut down Elasticsearch {ref_id} on deployment {deployment_id} without taking a snapshot.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters'].post
  update:
    x-apievangelist-phrasing:
      intent: List remote clusters eligible for one cluster
      effect: read
      questions:
      - Which deployments could I connect as remote clusters to this specific Elasticsearch cluster?
      - How do I find remote cluster candidates for my existing cluster?
      instructions:
      - text: List eligible remote clusters for Elasticsearch resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Find deployments that can be remotes for cluster {ref_id} on deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/instances/{instance_ids}/_move'].post
  update:
    x-apievangelist-phrasing:
      intent: Move Elasticsearch instances to another allocator
      effect: write
      questions:
      - How do I move Elasticsearch instances off an allocator?
      - Can I force-move instances even when they are down?
      instructions:
      - text: Move instances {instance_ids} of Elasticsearch resource {ref_id} in deployment {deployment_id} to another allocator.
        slots:
          instance_ids: path.instance_ids
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Force-move Elasticsearch instances {instance_ids} on deployment {deployment_id}, resource {ref_id}.
        slots:
          instance_ids: path.instance_ids
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore'].get
  update:
    x-apievangelist-phrasing:
      intent: List Elasticsearch keystore entries
      effect: read
      questions:
      - What secure settings are stored in my Elasticsearch keystore?
      - Can I see keystore keys without exposing their values?
      instructions:
      - text: List keystore entries for Elasticsearch resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Show the keystore fields on deployment {deployment_id}, cluster {ref_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or remove Elasticsearch keystore secrets
      effect: write
      questions:
      - How do I add a secure setting to the Elasticsearch keystore?
      - Can I remove a secret from the keystore of my cluster?
      instructions:
      - text: Add secrets {secrets} to the keystore of Elasticsearch {ref_id} in deployment {deployment_id}.
        slots:
          secrets: requestBody.secrets
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Update the keystore on deployment {deployment_id}, cluster {ref_id}, with {secrets}.
        slots:
          secrets: requestBody.secrets
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificate-based remote clusters
      effect: read
      questions:
      - Which certificate-based remote clusters are configured on my cluster?
      - How do I see the remote clusters already linked to an Elasticsearch resource?
      instructions:
      - text: List certificate-based remote clusters for Elasticsearch {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Show configured remote clusters on deployment {deployment_id}, resource {ref_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters'].put
  update:
    x-apievangelist-phrasing:
      intent: Set certificate-based remote clusters
      effect: write
      questions:
      - How do I configure certificate-based remote clusters for cross-cluster search?
      - Does setting remote clusters replace the existing list?
      instructions:
      - text: Set remote clusters {resources} on Elasticsearch {ref_id} in deployment {deployment_id}.
        slots:
          resources: requestBody.resources
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Overwrite the remote cluster list for deployment {deployment_id}, resource {ref_id}, with {resources}.
        slots:
          resources: requestBody.resources
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository'].get
  update:
    x-apievangelist-phrasing:
      intent: List attached snapshot repositories
      effect: read
      questions:
      - Which other deployments' snapshot repositories can my cluster read from?
      - How do I see snapshot repositories linked to a deployment?
      instructions:
      - text: List attached snapshot repositories for Elasticsearch {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Show linked snapshot repositories on deployment {deployment_id}, cluster {ref_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository'].post
  update:
    x-apievangelist-phrasing:
      intent: Link another deployment's snapshot repository
      effect: write
      questions:
      - How do I let my cluster access snapshots from another deployment?
      - Can I attach a source deployment's snapshots to a new cluster?
      instructions:
      - text: Attach snapshots from deployment {source_deployment_id} to Elasticsearch {ref_id} in deployment {deployment_id}.
        slots:
          source_deployment_id: requestBody.source_deployment_id
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Create a snapshot repository link on deployment {deployment_id}, resource {ref_id}, sourced from {source_deployment_id}.
        slots:
          source_deployment_id: requestBody.source_deployment_id
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository/{repository_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an attached snapshot repository
      effect: destructive
      questions:
      - How do I detach a snapshot repository from my deployment?
      - Can I remove a linked repository that searchable snapshots still use?
      instructions:
      - text: Remove snapshot repository {repository_name} from Elasticsearch {ref_id} in deployment {deployment_id}.
        slots:
          repository_name: path.repository_name
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Detach repository {repository_name} from deployment {deployment_id}, cluster {ref_id}.
        slots:
          repository_name: path.repository_name
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Elasticsearch tier sizes and zones
      effect: read
      questions:
      - How much memory and how many zones does each data tier have?
      - What sizes are available for my hot, warm and cold tiers?
      instructions:
      - text: Show the Elasticsearch tiers for resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Get tier memory sizes and zone counts on deployment {deployment_id}, cluster {ref_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/elasticsearch/{ref_id}/tiers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Resize Elasticsearch data tiers
      effect: write
      questions:
      - How do I scale up the hot tier of my cluster?
      - Can I change the zone count of the warm tier?
      instructions:
      - text: Resize the hot tier of Elasticsearch {ref_id} in deployment {deployment_id} to {hot_content}.
        slots:
          hot_content: requestBody.hot_content
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Set the warm tier on deployment {deployment_id}, cluster {ref_id}, to {warm}.
        slots:
          warm: requestBody.warm
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/enterprise_search/{ref_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's Enterprise Search resource info
      effect: read
      questions:
      - Where can I inspect the Enterprise Search component running in my deployment?
      - Can I view the Enterprise Search plan defaults?
      instructions:
      - text: Get Enterprise Search resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Show Enterprise Search {ref_id} plan defaults for deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/heap_dumps'].get
  update:
    x-apievangelist-phrasing:
      intent: List heap dumps for a deployment
      effect: read
      questions:
      - Which heap dumps exist or are being captured for my deployment?
      - How do I check the progress of an on-demand heap dump?
      instructions:
      - text: List heap dumps for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Show in-progress heap dump captures on deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/integrations_server/{ref_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's Integrations Server info
      effect: read
      questions:
      - How do I see the details of the Integrations Server in my deployment?
      - Can I view the Integrations Server's current settings?
      instructions:
      - text: Get Integrations Server resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Show Integrations Server {ref_id} metadata for deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/kibana/{ref_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's Kibana resource info
      effect: read
      questions:
      - How do I see the details of the Kibana instance in a deployment?
      - Can I view Kibana's plan history for a deployment?
      instructions:
      - text: Get Kibana resource {ref_id} in deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Show Kibana {ref_id} plan history on deployment {deployment_id}.
        slots:
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/migrate_template'].get
  update:
    x-apievangelist-phrasing:
      intent: Build a request to switch deployment template
      effect: read
      questions:
      - How do I move a deployment to a different deployment template?
      - What would the update request look like to migrate to another template?
      instructions:
      - text: Build the migration request to move deployment {deployment_id} to template {template_id}.
        slots:
          deployment_id: path.deployment_id
          template_id: query.template_id
      - text: Preview migrating deployment {deployment_id} onto template {template_id}.
        slots:
          deployment_id: path.deployment_id
          template_id: query.template_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's tags
      effect: read
      questions:
      - What tags are on my deployment?
      - How can I read the labels attached to a deployment?
      instructions:
      - text: Get the tags for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Show the labels on deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/tags'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a deployment's tags
      effect: write
      questions:
      - How do I tag a deployment?
      - Does setting tags overwrite the ones already on the deployment?
      instructions:
      - text: Set the tags on deployment {deployment_id} to {tags}.
        slots:
          deployment_id: path.deployment_id
          tags: requestBody.tags
      - text: Replace all tags on deployment {deployment_id} with {tags}.
        slots:
          deployment_id: path.deployment_id
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/upgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Upgrade a deployment's Elastic Stack version
      effect: write
      questions:
      - How do I upgrade my whole deployment to a newer Elastic Stack version?
      - Does the upgrade cover Kibana and APM as well as Elasticsearch?
      instructions:
      - text: Upgrade deployment {deployment_id} to version {target_version}.
        slots:
          deployment_id: path.deployment_id
          target_version: requestBody.target_version
      - text: Move all resources in deployment {deployment_id} to Elastic Stack {target_version}.
        slots:
          deployment_id: path.deployment_id
          target_version: requestBody.target_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/upgrade_assistant/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check upgrade readiness for a deployment
      effect: read
      questions:
      - Is my deployment ready to upgrade to the next version?
      - What does the upgrade assistant report for my cluster?
      instructions:
      - text: Get the upgrade assistant status for deployment {deployment_id}.
        slots:
          deployment_id: path.deployment_id
      - text: Check upgrade readiness of deployment {deployment_id} for version {target_version}.
        slots:
          deployment_id: path.deployment_id
          target_version: query.target_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore one shut-down resource
      effect: write
      questions:
      - How do I restore a single resource that was shut down, like Kibana?
      - Can I bring back just one component of a deployment from snapshot?
      instructions:
      - text: Restore the {resource_kind} resource {ref_id} in deployment {deployment_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Bring back shut-down {resource_kind} {ref_id} on deployment {deployment_id} from snapshot.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/activity/{attempt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single plan activity attempt
      effect: read
      questions:
      - How do I see what happened during a specific plan change attempt?
      - Where can I find the details of one plan attempt for a resource?
      instructions:
      - text: Get plan attempt {attempt_id} for {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          attempt_id: path.attempt_id
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Show plan activity {attempt_id} on deployment {deployment_id}, {resource_kind} {ref_id}.
        slots:
          attempt_id: path.attempt_id
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/diagnostics/_capture'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture a diagnostic bundle
      effect: write
      questions:
      - How do I grab a diagnostic bundle from my Elasticsearch or Kibana cluster?
      - Does the cluster need to be responsive to capture diagnostics?
      instructions:
      - text: Capture diagnostics for {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Collect a diagnostic bundle in {mode} mode from deployment {deployment_id}, {resource_kind} {ref_id}.
        slots:
          mode: query.mode
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start every instance of a resource
      effect: write
      questions:
      - How do I start all instances of a deployment resource at once?
      - Can I power on every node of a stopped component?
      instructions:
      - text: Start all instances of {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Power on every node of {resource_kind} {ref_id} on deployment {deployment_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop every instance of a resource
      effect: write
      questions:
      - How do I stop all instances of a deployment resource at once?
      - Can I halt every node of a component in one call?
      instructions:
      - text: Stop all instances of {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Halt every node of {resource_kind} {ref_id} on deployment {deployment_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start'].post
  update:
    x-apievangelist-phrasing:
      intent: Put all instances into maintenance mode
      effect: write
      questions:
      - How do I put every instance of a resource into maintenance mode?
      - Can I enable maintenance mode across a whole component?
      instructions:
      - text: Start maintenance mode on all instances of {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Put every node of {resource_kind} {ref_id} on deployment {deployment_id} into maintenance.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Take all instances out of maintenance mode
      effect: write
      questions:
      - How do I end maintenance mode for every instance of a resource?
      - Can I bring a whole component out of maintenance in one step?
      instructions:
      - text: Stop maintenance mode on all instances of {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Take every node of {resource_kind} {ref_id} on deployment {deployment_id} out of maintenance.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/overrides'].put
  update:
    x-apievangelist-phrasing:
      intent: Override size for all instances of a resource
      effect: write
      questions:
      - How do I temporarily bump capacity on every instance of a resource?
      - Do instance size overrides survive the next plan change?
      instructions:
      - text: Override capacity to {capacity} for all instances of {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          capacity: requestBody.capacity
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Set a storage multiplier of {storage_multiplier} across every node of {resource_kind} {ref_id} on deployment {deployment_id}.
        slots:
          storage_multiplier: requestBody.storage_multiplier
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start specific instances of a resource
      effect: write
      questions:
      - How do I start only certain instances of a resource?
      - Can I start selected nodes and ignore ones that are missing?
      instructions:
      - text: Start instances {instance_ids} of {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          instance_ids: path.instance_ids
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Power on just nodes {instance_ids} on deployment {deployment_id}, {resource_kind} {ref_id}.
        slots:
          instance_ids: path.instance_ids
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop specific instances of a resource
      effect: write
      questions:
      - How do I stop only certain instances of a resource?
      - Can I stop selected nodes without touching the rest?
      instructions:
      - text: Stop instances {instance_ids} of {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          instance_ids: path.instance_ids
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Halt just nodes {instance_ids} on deployment {deployment_id}, {resource_kind} {ref_id}.
        slots:
          instance_ids: path.instance_ids
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start'].post
  update:
    x-apievangelist-phrasing:
      intent: Put specific instances into maintenance mode
      effect: write
      questions:
      - How do I put just a few instances into maintenance mode?
      - Can I enable maintenance mode on selected nodes only?
      instructions:
      - text: Enable maintenance mode only for nodes {instance_ids} of {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          instance_ids: path.instance_ids
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Put nodes {instance_ids} of deployment {deployment_id}, {resource_kind} {ref_id}, into maintenance.
        slots:
          instance_ids: path.instance_ids
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Take specific instances out of maintenance mode
      effect: write
      questions:
      - How do I end maintenance mode on just a few instances?
      - Can I bring selected nodes back out of maintenance?
      instructions:
      - text: Disable maintenance mode only for nodes {instance_ids} of {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          instance_ids: path.instance_ids
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Take nodes {instance_ids} of deployment {deployment_id}, {resource_kind} {ref_id}, out of maintenance.
        slots:
          instance_ids: path.instance_ids
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/overrides'].put
  update:
    x-apievangelist-phrasing:
      intent: Override size for specific instances
      effect: write
      questions:
      - How do I give just one or two instances more capacity temporarily?
      - Can I restart selected instances after overriding their size?
      instructions:
      - text: Give only nodes {instance_ids} of {resource_kind} {ref_id} in deployment {deployment_id} a temporary capacity of {capacity}.
        slots:
          capacity: requestBody.capacity
          instance_ids: path.instance_ids
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Set storage multiplier {storage_multiplier} on nodes {instance_ids} of deployment {deployment_id}, {resource_kind} {ref_id}.
        slots:
          storage_multiplier: requestBody.storage_multiplier
          instance_ids: path.instance_ids
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture an on-demand heap dump
      effect: write
      questions:
      - How do I take a heap dump of a single instance that is using too much memory?
      - Is heap dump capture asynchronous?
      instructions:
      - text: Capture a heap dump of instance {instance_id} in {resource_kind} {ref_id} of deployment {deployment_id}.
        slots:
          instance_id: path.instance_id
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Start a new heap dump on node {instance_id} for deployment {deployment_id}, {resource_kind} {ref_id}.
        slots:
          instance_id: path.instance_id
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an instance's heap dump
      effect: read
      questions:
      - How do I download a heap dump once it has been captured?
      - Can I fetch the heap dump file for one instance?
      instructions:
      - text: Download the heap dump of instance {instance_id} in {resource_kind} {ref_id} of deployment {deployment_id}.
        slots:
          instance_id: path.instance_id
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Fetch node {instance_id}'s heap dump file from deployment {deployment_id}, {resource_kind} {ref_id}.
        slots:
          instance_id: path.instance_id
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture a thread dump from an instance
      effect: write
      questions:
      - How do I get a thread dump from a stuck instance?
      - Does a thread dump capture return its contents right away?
      instructions:
      - text: Capture a thread dump of instance {instance_id} in {resource_kind} {ref_id} of deployment {deployment_id}.
        slots:
          instance_id: path.instance_id
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Take a thread dump on node {instance_id} for deployment {deployment_id}, {resource_kind} {ref_id}.
        slots:
          instance_id: path.instance_id
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw'].post
  update:
    x-apievangelist-phrasing:
      intent: Overwrite a resource's internal metadata
      effect: write
      questions:
      - How do I replace the raw internal metadata JSON on a deployment resource?
      - Can I set resource metadata only if the version still matches?
      instructions:
      - text: Overwrite the raw metadata of {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Set raw metadata on deployment {deployment_id}, {resource_kind} {ref_id}, at version {version}.
        slots:
          version: query.version
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a resource's internal metadata
      effect: write
      questions:
      - How do I merge a small change into a resource's raw metadata?
      - Can I patch internal metadata without replacing all of it?
      instructions:
      - text: Patch the raw metadata of {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Apply a partial metadata change to deployment {deployment_id}, {resource_kind} {ref_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a resource's pending plan
      effect: destructive
      questions:
      - How do I cancel a plan change that is stuck in progress?
      - Can I force-delete a pending plan on a resource?
      instructions:
      - text: Cancel the pending plan for {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Force-cancel the in-progress plan on deployment {deployment_id}, {resource_kind} {ref_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}'].get
  update:
    x-apievangelist-phrasing:
      intent: Proxy a GET request to a deployment resource
      effect: read
      questions:
      - How do I send a GET call straight through to my cluster's API for management?
      - What header is required when proxying reads to a deployment resource?
      instructions:
      - text: Proxy a GET to {proxy_path} on {resource_kind} {ref_id} in deployment {deployment_id} with management header {X-Management-Request}.
        slots:
          proxy_path: path.proxy_path
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
          X-Management-Request: header.X-Management-Request
      - text: Read {proxy_path} from deployment {deployment_id}'s {resource_kind} {ref_id} through the proxy.
        slots:
          proxy_path: path.proxy_path
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}'].put
  update:
    x-apievangelist-phrasing:
      intent: Proxy a PUT request to a deployment resource
      effect: write
      questions:
      - How do I send a PUT call through the proxy to my cluster?
      - Can I update a cluster setting via a proxied PUT?
      instructions:
      - text: Proxy a PUT to {proxy_path} on {resource_kind} {ref_id} in deployment {deployment_id} with management header {X-Management-Request}.
        slots:
          proxy_path: path.proxy_path
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
          X-Management-Request: header.X-Management-Request
      - text: Send a proxied PUT to {proxy_path} on deployment {deployment_id}'s {resource_kind} {ref_id}.
        slots:
          proxy_path: path.proxy_path
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}'].post
  update:
    x-apievangelist-phrasing:
      intent: Proxy a POST request to a deployment resource
      effect: write
      questions:
      - Can I submit a POST body to my cluster's API through the deployment proxy?
      - Can I run a management POST against Kibana via the deployment proxy?
      instructions:
      - text: Proxy a POST to {proxy_path} on {resource_kind} {ref_id} in deployment {deployment_id} with management header {X-Management-Request}.
        slots:
          proxy_path: path.proxy_path
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
          X-Management-Request: header.X-Management-Request
      - text: Send a proxied POST to {proxy_path} on deployment {deployment_id}'s {resource_kind} {ref_id}.
        slots:
          proxy_path: path.proxy_path
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Proxy a DELETE request to a deployment resource
      effect: destructive
      questions:
      - What's the way to issue a DELETE against my cluster's API via the deployment proxy?
      - Can I remove something on the cluster via a proxied DELETE?
      instructions:
      - text: Proxy a DELETE to {proxy_path} on {resource_kind} {ref_id} in deployment {deployment_id} with management header {X-Management-Request}.
        slots:
          proxy_path: path.proxy_path
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
          X-Management-Request: header.X-Management-Request
      - text: Send a proxied DELETE to {proxy_path} on deployment {deployment_id}'s {resource_kind} {ref_id}.
        slots:
          proxy_path: path.proxy_path
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource's user settings
      effect: read
      questions:
      - What custom user settings are applied to a deployment component?
      - How do I read the user-defined settings for Kibana or Elasticsearch?
      instructions:
      - text: Get the user settings for {resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Show user-defined settings on deployment {deployment_id}, {resource_kind} {ref_id}.
        slots:
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a resource's user settings
      effect: write
      questions:
      - How do I change the user settings for a deployment component?
      - Will submitting an empty object clear all component-level user settings?
      instructions:
      - text: Replace user settings of {resource_kind} {ref_id} in deployment {deployment_id} with {user_settings}.
        slots:
          user_settings: requestBody.user_settings
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Overwrite component user settings on deployment {deployment_id}, {resource_kind} {ref_id}, to {user_settings}.
        slots:
          user_settings: requestBody.user_settings
          resource_kind: path.resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stateless resource from a deployment
      effect: destructive
      questions:
      - How do I remove Kibana or APM from a deployment entirely?
      - Does a stateless resource have to be shut down before I delete it?
      instructions:
      - text: Delete the {stateless_resource_kind} resource {ref_id} from deployment {deployment_id}.
        slots:
          stateless_resource_kind: path.stateless_resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Remove stateless {stateless_resource_kind} {ref_id} from deployment {deployment_id} permanently.
        slots:
          stateless_resource_kind: path.stateless_resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart'].post
  update:
    x-apievangelist-phrasing:
      intent: Restart a stateless resource like Kibana
      effect: write
      questions:
      - How do I restart Kibana or APM in a deployment?
      - Can I cancel a pending plan while restarting a stateless resource?
      instructions:
      - text: Restart {stateless_resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          stateless_resource_kind: path.stateless_resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Restart stateless {stateless_resource_kind} {ref_id} on deployment {deployment_id}, cancelling any pending plan.
        slots:
          stateless_resource_kind: path.stateless_resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Shut down a stateless resource
      effect: destructive
      questions:
      - How do I shut down APM or Enterprise Search without touching Elasticsearch?
      - Why can't Kibana be shut down on Elasticsearch Service?
      instructions:
      - text: Shut down {stateless_resource_kind} {ref_id} in deployment {deployment_id}.
        slots:
          stateless_resource_kind: path.stateless_resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      - text: Shut down stateless {stateless_resource_kind} {ref_id} on deployment {deployment_id} and hide it.
        slots:
          stateless_resource_kind: path.stateless_resource_kind
          ref_id: path.ref_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-09-26'