Deployments

54 endpoints

• List Deployments
  • GET /deployments
• Create Deployment
  • POST /deployments
• Search Deployments
  • POST /deployments/_search
• Get eligible remote clusters
  • POST /deployments/eligible-remote-clusters
• Get eligible remote clusters
  • POST /deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters
• Get Deployment
  • GET /deployments/{deployment_id}
• Update Deployment
  • PUT /deployments/{deployment_id}
• Restores a shutdown Deployment
  • POST /deployments/{deployment_id}/_restore
• Shuts down Deployment
  • POST /deployments/{deployment_id}/_shutdown
• Get Deployment APM Resource Info
  • GET /deployments/{deployment_id}/apm/{ref_id}
• Reset the secret token for an APM resource.
  • POST /deployments/{deployment_id}/apm/{ref_id}/_reset-token
• Get Deployment App Search Resource Info
  • GET /deployments/{deployment_id}/appsearch/{ref_id}
• Set AppSearch read-only status
  • GET /deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode
• Set AppSearch read-only status
  • PUT /deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode
• Migrate Deployment BYOK
  • POST /deployments/{deployment_id}/byok-migration
• Get certificate authority
  • GET /deployments/{deployment_id}/certificate-authority
• Get Deployment Elasticsearch Resource Info
  • GET /deployments/{deployment_id}/elasticsearch/{ref_id}
• Migrate Elasticsearch and associated Kibana resources to enable CCR
  • POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr
• Migrate Elasticsearch resource to use ILM
  • POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm
• Migrate Elasticsearch resource to use SLM
  • POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm
• Reset 'elastic' user password
  • POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password
• Restart Deployment Elasticsearch Resource
  • POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_restart
• Shutdown Deployment Elasticsearch Resource
  • POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown
• Get the items in the Elasticsearch resource keystore
  • GET /deployments/{deployment_id}/elasticsearch/{ref_id}/keystore
• Add or remove items from the Elasticsearch resource keystore
  • PATCH /deployments/{deployment_id}/elasticsearch/{ref_id}/keystore
• Get certificate based remote clusters
  • GET /deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
• Set certificate based remote clusters
  • PUT /deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
• List the attached snapshot repositories
  • GET /deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository
• Create a snapshot repository for Elasticsearch resource
  • POST /deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository
• Remove the attached snapshot repository
  • DELETE /deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository/{repository_name}
• Get Elasticsearch tiers
  • GET /deployments/{deployment_id}/elasticsearch/{ref_id}/tiers
• Update Elasticsearch tiers
  • PATCH /deployments/{deployment_id}/elasticsearch/{ref_id}/tiers
• Get Deployment Enterprise Search Resource Info
  • GET /deployments/{deployment_id}/enterprise_search/{ref_id}
• Get Deployment Integrations Server Resource Info
  • GET /deployments/{deployment_id}/integrations_server/{ref_id}
• Get Deployment Kibana Resource Info
  • GET /deployments/{deployment_id}/kibana/{ref_id}
• Build request to migrate deployment to a different template
  • GET /deployments/{deployment_id}/migrate_template
• Get the tags for a Deployment
  • GET /deployments/{deployment_id}/tags
• Set the tags for a Deployment
  • PUT /deployments/{deployment_id}/tags
• Upgrade a Deployment to a new Elastic Stack version
  • POST /deployments/{deployment_id}/upgrade
• Get Deployment upgrade assistant status
  • GET /deployments/{deployment_id}/upgrade_assistant/status
• Restores a shutdown resource
  • POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore
• Start all instances
  • POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start
• Stop all instances
  • POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_stop
• Start maintenance mode (all instances)
  • POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start
• Stop maintenance mode (all instances)
  • POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_stop
• Start instances
  • POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start
• Stop instances
  • POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop
• Start maintenance mode
  • POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start
• Stop maintenance mode
  • POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop
• Cancel resource pending plan
  • DELETE /deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending
• Get the user settings of a Deployment resource
  • GET /deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings
• Update user settings for a deployment resource
  • PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings
• Restart Deployment Stateless Resource
  • POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart
• Shutdown Deployment Stateless Resource
  • POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown