Elasticsearch API
  1. Schemas
Elasticsearch API
  • Accounts
    • Updates the current account
    • Updates the current account
    • Fetch current account information
  • Authentication
    • Delete API key
    • Get API key
    • Create API key
    • Delete API keys
    • Get all API keys
  • BillingCostsAnalysis
    • Get costs overview for the organization
    • Get deployments costs for the organization
    • Get itemized costs for the organization
    • Get itemized costs by deployments
  • DeploymentTemplates
    • Get deployment templates
    • Get deployment template
  • Deployments
    • Shutdown Deployment Elasticsearch Resource
    • Start all instances
    • Restores a shutdown resource
    • Restores a shutdown Deployment
    • Set remote clusters
    • Get remote clusters
    • Stop instances
    • Reset the secret token for an APM resource.
    • Get Deployment Enterprise Search Resource Info
    • Get Deployment Kibana Resource Info
    • Set AppSearch read-only status
    • Set AppSearch read-only status
    • Start instances
    • Restart Deployment Stateless Resource
    • Shuts down Deployment
    • Migrate Elasticsearch resource to use SLM
    • Start maintenance mode
    • Restart Deployment Elasticsearch Resource
    • Start maintenance mode (all instances)
    • Reset 'elastic' user password
    • Stop all instances
    • Migrate Elasticsearch and associated Kibana resources to enable CCR
    • Add or remove settings from the Elasticsearch resource keystore
    • Get the settings from the Elasticsearch resource keystore
    • Search Deployments
    • Get eligible remote clusters
    • Update Deployment
    • Get Deployment
    • Get Deployment Elasticsearch Resource Info
    • Stop maintenance mode (all instances)
    • Migrate Elasticsearch resource to use ILM
    • Shutdown Deployment Stateless Resource
    • Get Deployment APM Resource Info
    • Stop maintenance mode
    • Cancel resource pending plan
    • Get Deployment App Search Resource Info
    • Get eligible remote clusters
    • Create Deployment
    • List Deployments
    • Upgrade Kibana, APM, AppSearch inside Deployment
  • DeploymentsTrafficFilter
    • Delete ruleset association
    • Create ruleset association
    • Get associated deployments
    • Create a ruleset
    • List traffic filter rulesets
    • Get associated rulesets
    • Updates a ruleset
    • Delete a ruleset
    • Retrieves the ruleset by ID.
  • Extensions
    • Create an extension
    • List Extensions
    • Uploads the Extension
    • Update Extension
    • Delete Extension
    • Get Extension
  • Stack
    • Get stack versions
  • 数据模型
    • 默认分组
    • Schemas
      • AppSearchPayload
      • ElasticsearchClusterPlansInfo
      • DeploymentSearchResponse
      • TransientAppSearchPlanConfiguration
      • SnapshotStatusInfo
      • ElasticsearchConfiguration
      • DtsDimensionCosts
      • RestoreSnapshotConfiguration
      • ApmConfiguration
      • ManagedMonitoringSettings
      • ElasticsearchScriptingUserSettings
      • PlanStrategy
      • ElasticsearchClusterUser
      • ElasticsearchShardsInfo
      • ElasticsearchClusterPlanInfo
      • ElasticsearchReplicaElement
      • ApiKeysResponse
      • DeploymentCosts
      • ApmPayload
      • BasicFailedReplyElement
      • RestoreSnapshotApiConfiguration
      • TransientElasticsearchPlanConfiguration
      • ClusterPlanStepLogMessageInfo
      • DeploymentUpdateRequest
      • KibanaConfiguration
      • RestoreSnapshotRepoConfiguration
      • KeystoreSecret
      • ClusterMetadataPortInfo
      • ElasticsearchNodeType
      • DeploymentResourceUpgradeResponse
      • CrossClusterSearchInfo
      • DeploymentDiagnostics
      • ElasticsearchDependant
      • EnterpriseSearchPlanInfo
      • ApmSettings
      • DeploymentTemplateInfoV2
      • ElasticsearchMonitoringInfo
      • ElasticsearchClusterBlockingIssueElement
      • DeploymentCreateRequest
      • ItemCosts
      • KibanaClusterInfo
      • ElasticsearchScriptTypeSettings
      • AppSearchPlansInfo
      • AppSearchConfiguration
      • RollingGrowShrinkStrategyConfig
      • ClusterMetadataInfo
      • Extensions
      • RemoteClusterInfo
      • ElasticsearchClusterSecurityInfo
      • AppSearch
      • DeploymentUpdateMetadata
      • ApiKeyResponse
      • TrafficFilterRulesets
      • TargetElasticsearchCluster
      • DeploymentRestoreResponse
      • ElasticsearchClusterRole
      • BoolQuery
      • FilterAssociation
      • ExtensionFileMetadata
      • ElasticsearchClusterPlan
      • SearchRequest
      • UpdateExtensionRequest
      • ElasticsearchClusterBlockingIssues
      • Orphaned
      • DeploymentUpdateResources
      • ClusterTopologyInfo
      • DiscreteSizes
      • CrossClusterSearchSettings
      • AppSearchNodeTypes
      • ElasticsearchMasterInfo
      • DeploymentCreateSettings
      • StackVersionApmConfig
      • EnterpriseSearchConfiguration
      • AppSearchSystemSettings
      • AccountUpdateRequest
      • EnterpriseSearchSettings
      • QueryStringQuery
      • NestedQuery
      • KibanaClusterTopologyElement
      • DeploymentsSearchResponse
      • StackVersionConfigs
      • Period
      • ElasticsearchMasterElement
      • ClusterCurationSettings
      • KibanaSubClusterInfo
      • StackVersionInstanceCapacityConstraint
      • SimplifiedLineItem
      • ClusterInstanceInfo
      • KeystoreContents
      • ClusterSnapshotRetention
      • AccountTrustRelationship
      • AutodetectStrategyConfig
      • InstanceMoveRequest
      • DtsQuantity
      • ChangeSourceInfo
      • ApmSubInfo
      • KibanaResourceInfo
      • EnterpriseSearchPlan
      • ClusterSnapshotSettings
      • DeploymentsListResponse
      • ElasticsearchCuration
      • DeploymentMetrics
      • DeploymentGetResponse
      • DeploymentSettings
      • EnterpriseSearch
      • RemoteClusterRef
      • MatchNoneQuery
      • EnterpriseSearchSubInfo
      • ApmTopologyElement
      • ServiceUrl
      • Extension
      • ClusterSystemAlert
      • DeploymentUpdateSettings
      • StackVersionAppSearchConfig
      • EnterpriseSearchPlansInfo
      • ApmCrudResponse
      • Creates
      • RulesetAssociations
      • ApmPlanInfo
      • PrefixQuery
      • AppSearchTopologyElement
      • ElasticsearchResourceInfo
      • ClusterMetadataSettings
      • AllocatorMoveRequest
      • ExternalTrustRelationship
      • DeploymentObservabilitySettings
      • CostsOverview
      • StackVersionMetadata
      • RemoteResourceRef
      • TrafficFilterRulesetResponse
      • Kibana
      • ClusterCurationSpec
      • TermQuery
      • Apm
      • AppSearchSettings
      • StackVersionKibanaConfig
      • EnterpriseSearchNodeTypes
      • KibanaClusterSettings
      • ElasticsearchPlanControlConfiguration
      • StackVersionTemplateInfo
      • ElasticsearchClusterInfo
      • EnableIlmRequest
      • TransientKibanaPlanConfiguration
      • DeploymentShutdownResponse
      • IpFilteringSettings
      • AppSearchResourceInfo
      • KibanaClusterPlansInfo
      • EmptyResponse
      • KibanaDeeplink
      • EnterpriseSearchSystemSettings
      • ExistsQuery
      • TopologyElementControl
      • EnterpriseSearchInfo
      • DeploymentsCosts
      • DeploymentResource
      • ApmPlansInfo
      • ReadOnlyRequest
      • ElasticsearchUserPlugin
      • ObservabilityIssue
      • DeploymentObservability
      • DeploymentResourceCommandResponse
      • Updates
      • IndexPattern
      • GrowShrinkStrategyConfig
      • TopologySize
      • DeploymentCreateResponse
      • AppSearchPlanControlConfiguration
      • Hyperlink
      • DtsRate
      • TrafficFilterSettings
      • StackVersionNodeType
      • EnterpriseSearchPlanControlConfiguration
      • DeploymentCreateMetadata
      • AppSearchInfo
      • AppSearchPlanInfo
      • TrafficFilterRulesetInfo
      • ElasticsearchInfo
      • Balance
      • ElasticsearchClusterTrustSettings
      • DeploymentsListingData
      • ClusterPlanStepInfo
      • MatchQuery
      • CreateExtensionRequest
      • ElasticsearchPayload
      • EnterpriseSearchResourceInfo
      • DeleteApiKeysRequest
      • KibanaClusterPlanInfo
      • RemoteResourceInfo
      • ApmResourceInfo
      • KibanaPlanControlConfiguration
      • ApmPlan
      • DeploymentTemplateReference
      • ApmInfo
      • ClusterCredentials
      • KibanaPayload
      • AppSearchSubInfo
      • QueryContainer
      • AbsoluteRefId
      • InstanceConfigurationInfo
      • DeploymentUpdateResponse
      • TransientApmPlanConfiguration
      • StackVersionConfig
      • DeploymentMetadata
      • ReadOnlyResponse
      • ElasticsearchClusterTopologyElement
      • DeploymentLoggingSettings
      • ElasticsearchElasticUserPasswordResetResponse
      • RemoteResources
      • DeploymentResources
      • StackVersionTemplateFileHash
      • TransientEnterpriseSearchPlanConfiguration
      • ElasticsearchClusterSettings
      • ReplyWarning
      • KibanaClusterPlan
      • AccountResponse
      • OrphanedElasticsearch
      • EnterpriseSearchTopologyElement
      • DeploymentCreateResources
      • ElasticsearchShardElement
      • ElasticsearchSystemSettings
      • ElasticsearchUserBundle
      • BasicFailedReply
      • KibanaSystemSettings
      • DeploymentMetricsSettings
      • ApmPlanControlConfiguration
      • DeploymentResourceCrudResponse
      • Costs
      • Elasticsearch
      • AccountTrustSettings
      • ClusterInstanceDiskInfo
      • DeploymentLogging
      • RollingStrategyConfig
      • MetadataItem
      • TrafficFilterRulesetRequest
      • TrafficFilterEgressRule
      • MatchAllQuery
      • TrafficFilterRule
      • AppSearchPlan
      • RangeQuery
      • ItemsCosts
      • ClusterInstanceConfigurationInfo
      • StackVersionElasticsearchConfig
      • ApmSystemSettings
      • ClusterInstanceMemoryInfo
      • ExternalHyperlink
      • CreateApiKeyRequest
  1. Schemas

ElasticsearchClusterPlan

The plan for the Elasticsearch cluster.

{
    "autoscaling_enabled": true,
    "cluster_topology": [
        {
            "autoscaling_policy_override_json": {},
            "zone_count": 0,
            "topology_element_control": {
                "min": {
                    "resource": "memory",
                    "value": 0
                }
            },
            "autoscaling_min": {
                "resource": "memory",
                "value": 0
            },
            "node_type": {
                "data": true,
                "master": true,
                "ingest": true,
                "ml": true
            },
            "elasticsearch": {
                "user_settings_override_json": {},
                "enabled_built_in_plugins": [
                    "string"
                ],
                "user_plugins": [
                    {
                        "url": "string",
                        "name": "string",
                        "elasticsearch_version": "string"
                    }
                ],
                "user_settings_yaml": "string",
                "user_bundles": [
                    {
                        "url": "string",
                        "name": "string",
                        "elasticsearch_version": "string"
                    }
                ],
                "version": "string",
                "user_settings_json": {},
                "curation": {
                    "to_instance_configuration_id": "string",
                    "from_instance_configuration_id": "string"
                },
                "system_settings": {
                    "reindex_whitelist": [
                        "string"
                    ],
                    "default_shards_per_index": 0,
                    "monitoring_history_duration": "string",
                    "monitoring_collection_interval": 0,
                    "destructive_requires_name": true,
                    "auto_create_index": true,
                    "watcher_trigger_engine": "string",
                    "use_disk_threshold": true,
                    "scripting": {
                        "expressions_enabled": true,
                        "stored": {
                            "enabled": true,
                            "sandbox_mode": true
                        },
                        "painless_enabled": true,
                        "file": {
                            "enabled": true,
                            "sandbox_mode": true
                        },
                        "inline": {
                            "enabled": true,
                            "sandbox_mode": true
                        },
                        "mustache_enabled": true
                    },
                    "enable_close_index": true
                },
                "user_settings_override_yaml": "string",
                "docker_image": "string",
                "node_attributes": {
                    "property1": "string",
                    "property2": "string"
                }
            },
            "autoscaling_max": {
                "resource": "memory",
                "value": 0
            },
            "instance_configuration_id": "string",
            "node_roles": [
                "master"
            ],
            "id": "string",
            "size": {
                "resource": "memory",
                "value": 0
            }
        }
    ],
    "transient": {
        "plan_configuration": {
            "cluster_reboot": "forced",
            "calm_wait_time": 0,
            "skip_snapshot": true,
            "max_snapshot_age": 0,
            "timeout": 0,
            "extended_maintenance": true,
            "max_snapshot_attempts": 0
        },
        "cluster_settings_json": {},
        "remote_clusters": {
            "resources": [
                {
                    "info": {
                        "healthy": true,
                        "compatible": true,
                        "connected": true,
                        "trusted": true,
                        "trusted_back": true
                    },
                    "elasticsearch_ref_id": "string",
                    "deployment_id": "string",
                    "skip_unavailable": true,
                    "alias": "string"
                }
            ]
        },
        "restore_snapshot": {
            "repository_config": {
                "raw_settings": {}
            },
            "repository_name": "string",
            "restore_payload": {
                "indices": [
                    "string"
                ],
                "raw_settings": {}
            },
            "strategy": "partial",
            "source_cluster_id": "string",
            "snapshot_name": "string"
        },
        "strategy": {
            "rolling": {
                "skip_synced_flush": true,
                "allow_inline_resize": true,
                "group_by": "string",
                "shard_init_wait_time": 0
            },
            "rolling_grow_and_shrink": {},
            "grow_and_shrink": {},
            "autodetect": {}
        }
    },
    "elasticsearch": {
        "user_settings_override_json": {},
        "enabled_built_in_plugins": [
            "string"
        ],
        "user_plugins": [
            {
                "url": "string",
                "name": "string",
                "elasticsearch_version": "string"
            }
        ],
        "user_settings_yaml": "string",
        "user_bundles": [
            {
                "url": "string",
                "name": "string",
                "elasticsearch_version": "string"
            }
        ],
        "version": "string",
        "user_settings_json": {},
        "curation": {
            "to_instance_configuration_id": "string",
            "from_instance_configuration_id": "string"
        },
        "system_settings": {
            "reindex_whitelist": [
                "string"
            ],
            "default_shards_per_index": 0,
            "monitoring_history_duration": "string",
            "monitoring_collection_interval": 0,
            "destructive_requires_name": true,
            "auto_create_index": true,
            "watcher_trigger_engine": "string",
            "use_disk_threshold": true,
            "scripting": {
                "expressions_enabled": true,
                "stored": {
                    "enabled": true,
                    "sandbox_mode": true
                },
                "painless_enabled": true,
                "file": {
                    "enabled": true,
                    "sandbox_mode": true
                },
                "inline": {
                    "enabled": true,
                    "sandbox_mode": true
                },
                "mustache_enabled": true
            },
            "enable_close_index": true
        },
        "user_settings_override_yaml": "string",
        "docker_image": "string",
        "node_attributes": {
            "property1": "string",
            "property2": "string"
        }
    },
    "deployment_template": {
        "version": "string",
        "id": "string"
    }
}
Built with