By default, retrieves only the available Elastic Stack versions. To retrieve all of the Elastic Stack versions, use the show_deleted parameter.
| Name | Type | Required | Description |
|---|---|---|---|
|
| N | Whether to show deleted stack versions or not |
|
| N | Whether to show versions that are unusable by the authenticated user |
200- (
StackVersionConfigs) The list of all available Elastic Stack versions are retrieved, including the template version and structure.
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Creates or updates an Elastic Stack pack and template.
The endpoint supports multipart/form-data requests, as well as application/zip and application/octet-stream requests with a binary body. The maximum size of the payload is 1Mb.
When the archive contains an Elastic Stack configuration that is available through the API, the configuration and template are overwritten.
| Name | Type | Required | Description |
|---|---|---|---|
|
| Y | Zip file that contains one or multiple stack configurations |
200- (
StackVersionArchiveProcessingResult) The Elastic Stack pack successfully processed. 400(
BasicFailedReply) * There is an error in the file. Choose a different file, then try again. (code:stackpack.bad_archive) * Some unexpected error occurred. (code:stackpack.unknown_internal_error)Headers
x-cloud-error-codes(string; allowed values: [stackpack.bad_archive,stackpack.unknown_internal_error])- The error codes associated with the response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Uses the deleted flag, which removes only that version of the Elastic Stack from the list of available versions. To restore the version, send an update request. For more information, see the PUT request.
| Name | Type | Required | Description |
|---|---|---|---|
|
| Y | The Elastic Stack version. For example, |
200- (
EmptyResponse) Thedeletedflag is applied to the specified Elastic Stack version. 404(
BasicFailedReply) The Elastic Stack version can't be found. (code:stackpack.version_not_found)Headers
x-cloud-error-codes(string; allowed values: [stackpack.version_not_found])- The error codes associated with the response
449(
BasicFailedReply) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required)Headers
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])- The error codes associated with the response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Retrieves the Elastic Stack version and template.
| Name | Type | Required | Description |
|---|---|---|---|
|
| Y | The Elastic Stack version. For example, |
200- (
StackVersionConfig) The Elastic Stack version is found. 404(
BasicFailedReply) The Elastic Stack version can't be found. (code:stackpack.version_not_found)Headers
x-cloud-error-codes(string; allowed values: [stackpack.version_not_found])- The error codes associated with the response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Updates the Elastic Stack version configuration.
| Name | Type | Required | Description |
|---|---|---|---|
|
| Y | The Elastic Stack version. For example, |
(StackVersionConfigPost) (required) Elastic Stack configuration object
200- (
StackVersionConfig) The Elastic Stack version successfully updated. 404(
BasicFailedReply) The Elastic Stack version can't be found. (code:stackpack.missing_platform_version)Headers
x-cloud-error-codes(string; allowed values: [stackpack.missing_platform_version])- The error codes associated with the response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
curl -XPUT {{hostname}}/api/v1/stack/versions/{version} \
-H "Authorization: ApiKey $CLOUD_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"apm" : {
"blacklist" : [
"string"
],
"capacity_constraints" : {
"max" : 0,
"min" : 0
},
"compatible_node_types" : [
"string"
],
"docker_image" : "string",
"settings" : {},
"version" : "string"
},
"appsearch" : {
"blacklist" : [
"string"
],
"capacity_constraints" : null,
"compatible_node_types" : [
"string"
],
"docker_image" : "string",
"node_types" : [
{
"capacity_constraints" : null,
"compatible_node_types" : [
"string"
],
"description" : "string",
"mandatory" : true,
"name" : "string",
"node_type" : "string",
"settings" : {}
}
],
"settings" : {},
"version" : "string"
},
"elasticsearch" : {
"blacklist" : [
"string"
],
"capacity_constraints" : null,
"compatible_node_types" : [
"string"
],
"default_plugins" : [
"string"
],
"docker_image" : "string",
"node_types" : [
null
],
"plugins" : [
"string"
],
"settings" : {}
},
"enterprisesearch" : {
"blacklist" : [
"string"
],
"capacity_constraints" : null,
"compatible_node_types" : [
"string"
],
"docker_image" : "string",
"node_types" : [
null
],
"settings" : {},
"version" : "string"
},
"kibana" : {
"blacklist" : [
"string"
],
"capacity_constraints" : null,
"compatible_node_types" : [
"string"
],
"docker_image" : "string",
"settings" : {},
"version" : "string"
},
"metadata" : {
"min_platform_version" : "string",
"notes" : "string",
"pre_release" : true,
"schema_version" : 0
},
"sitesearch" : {
"blacklist" : [
"string"
],
"capacity_constraints" : null,
"compatible_node_types" : [
"string"
],
"docker_image" : "string",
"node_types" : [
null
],
"settings" : {},
"version" : "string"
}
}
'