Elasticsearch API
  1. Stack
Elasticsearch API
  • Accounts
    • Updates the current account
      PUT
    • Updates the current account
      PATCH
    • Fetch current account information
      GET
  • Authentication
    • Delete API key
      DELETE
    • Get API key
      GET
    • Create API key
      POST
    • Delete API keys
      DELETE
    • Get all API keys
      GET
  • BillingCostsAnalysis
    • Get costs overview for the organization
      GET
    • Get deployments costs for the organization
      GET
    • Get itemized costs for the organization
      GET
    • Get itemized costs by deployments
      GET
  • DeploymentTemplates
    • Get deployment templates
      GET
    • Get deployment template
      GET
  • Deployments
    • Shutdown Deployment Elasticsearch Resource
      POST
    • Start all instances
      POST
    • Restores a shutdown resource
      POST
    • Restores a shutdown Deployment
      POST
    • Set remote clusters
      PUT
    • Get remote clusters
      GET
    • Stop instances
      POST
    • Reset the secret token for an APM resource.
      POST
    • Get Deployment Enterprise Search Resource Info
      GET
    • Get Deployment Kibana Resource Info
      GET
    • Set AppSearch read-only status
      PUT
    • Set AppSearch read-only status
      GET
    • Start instances
      POST
    • Restart Deployment Stateless Resource
      POST
    • Shuts down Deployment
      POST
    • Migrate Elasticsearch resource to use SLM
      POST
    • Start maintenance mode
      POST
    • Restart Deployment Elasticsearch Resource
      POST
    • Start maintenance mode (all instances)
      POST
    • Reset 'elastic' user password
      POST
    • Stop all instances
      POST
    • Migrate Elasticsearch and associated Kibana resources to enable CCR
      POST
    • Add or remove settings from the Elasticsearch resource keystore
      PATCH
    • Get the settings from the Elasticsearch resource keystore
      GET
    • Search Deployments
      POST
    • Get eligible remote clusters
      POST
    • Update Deployment
      PUT
    • Get Deployment
      GET
    • Get Deployment Elasticsearch Resource Info
      GET
    • Stop maintenance mode (all instances)
      POST
    • Migrate Elasticsearch resource to use ILM
      POST
    • Shutdown Deployment Stateless Resource
      POST
    • Get Deployment APM Resource Info
      GET
    • Stop maintenance mode
      POST
    • Cancel resource pending plan
      DELETE
    • Get Deployment App Search Resource Info
      GET
    • Get eligible remote clusters
      POST
    • Create Deployment
      POST
    • List Deployments
      GET
    • Upgrade Kibana, APM, AppSearch inside Deployment
      POST
  • 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
      GET
  1. Stack

Get stack versions

开发环境
http://127.0.0.1
开发环境
http://127.0.0.1
GET
/stack/versions
Stack
By default, retrieves only the available Elastic Stack versions. To retrieve all of the Elastic Stack versions, use the show_deleted parameter.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://127.0.0.1/stack/versions' \
--header 'Authorization: ApiKey {{EC_API_KEY}}'
响应示例响应示例
{
    "stacks": [
        {
            "accessible": true,
            "min_upgradable_from": "6.7.0",
            "deleted": true,
            "whitelisted": true,
            "kibana": {
                "settings": {},
                "blacklist": [
                    "string"
                ],
                "version": "string",
                "capacity_constraints": {
                    "max": 0,
                    "min": 0
                },
                "compatible_node_types": [
                    "string"
                ],
                "docker_image": "string"
            },
            "upgradable_to": [
                "string"
            ],
            "version": "string",
            "elasticsearch": {
                "settings": {},
                "node_types": [
                    {
                        "mandatory": true,
                        "name": "string",
                        "settings": {},
                        "node_type": "string",
                        "capacity_constraints": {
                            "max": 0,
                            "min": 0
                        },
                        "compatible_node_types": [
                            "string"
                        ],
                        "description": "string"
                    }
                ],
                "blacklist": [
                    "string"
                ],
                "plugins": [
                    "string"
                ],
                "capacity_constraints": {
                    "max": 0,
                    "min": 0
                },
                "compatible_node_types": [
                    "string"
                ],
                "default_plugins": [
                    "string"
                ],
                "docker_image": "string"
            },
            "template": {
                "hashes": [
                    {
                        "path": "string",
                        "hash": "string"
                    }
                ],
                "template_version": "string"
            },
            "apm": {
                "settings": {},
                "blacklist": [
                    "string"
                ],
                "version": "string",
                "capacity_constraints": {
                    "max": 0,
                    "min": 0
                },
                "compatible_node_types": [
                    "string"
                ],
                "docker_image": "string"
            },
            "appsearch": {
                "settings": {},
                "node_types": [
                    {
                        "mandatory": true,
                        "name": "string",
                        "settings": {},
                        "node_type": "string",
                        "capacity_constraints": {
                            "max": 0,
                            "min": 0
                        },
                        "compatible_node_types": [
                            "string"
                        ],
                        "description": "string"
                    }
                ],
                "blacklist": [
                    "string"
                ],
                "version": "string",
                "capacity_constraints": {
                    "max": 0,
                    "min": 0
                },
                "compatible_node_types": [
                    "string"
                ],
                "docker_image": "string"
            },
            "metadata": {
                "pre_release": true,
                "min_wire_compatibility_version": "string",
                "schema_version": 0,
                "min_index_compatibility_version": "string",
                "min_platform_version": "string",
                "notes": "string"
            }
        }
    ]
}

请求参数

Query 参数
show_deleted
可选
Whether to show deleted stack versions or not
show_unusable
可选
Whether to show versions that are unusable by the authenticated user
Header 参数
Authorization
string 
可选
默认值:
ApiKey {{EC_API_KEY}}

返回响应

🟢200The list of all available Elastic Stack versions are retrieved, including the template version and structure.
application/json
Body
The details for multiple Elastic Stack configurations.
stacks
array[object (StackVersionConfig) {12}] 
必需
accessible
boolean 
可选
Whether or not this version is accessible by the calling user. This is only relevant in EC (SaaS) and is not sent in ECE.
min_upgradable_from
string 
可选
The minimum version recommended to upgrade this version.
示例值:
6.7.0
deleted
boolean 
只读可选
Identifies that the Elastic Stack version is marked for deletion
whitelisted
boolean 
可选
Whether or not this version is whitelisted. This is only relevant in EC (SaaS) and is not sent in ECE.
kibana
object (StackVersionKibanaConfig) 
必需
The Kibana configuration for an Elastic Stack version.
upgradable_to
array[string]
必需
Stack Versions that this version can upgrade to
version
string 
只读可选
Stack version
elasticsearch
object (StackVersionElasticsearchConfig) 
必需
The Elasticsearch configuration for an Elastic Stack version.
template
object (StackVersionTemplateInfo) 
必需
The template information for an Elastic Stack version.
apm
object (StackVersionApmConfig) 
可选
The APM Server configuration for an Elastic Stack version.
appsearch
object (StackVersionAppSearchConfig) 
可选
AppSearch related configuration of an Elastic Stack version
metadata
object (StackVersionMetadata) 
可选
The metadata for the Elastic Stack.
上一页
Get Extension
Built with