Create clusteredit
Creates an APM cluster for a given Elasticsearch cluster.
Requestedit
POST /api/v1/clusters/apm
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
When |
Request bodyedit
(CreateApmRequest) (required) The cluster definition
Responsesedit
-
200 -
(
ApmCrudResponse) The APM server plan is valid. The return object contains an internal representation of the plan that you can use for debugging. -
201 -
(
ApmCrudResponse) The APM server plan is valid and the creation process has started. -
400 -
(
BasicFailedReply) The APM server plan contains errors. (code: 'clusters.cluster_invalid_plan' and 'clusters.plan_feature_not_implemented') -
449 -
(
BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPOST {{hostname}}/api/v1/clusters/apm \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"display_name" : "string",
"elasticsearch_cluster_id" : "string",
"plan" : {
"apm" : {
"docker_image" : "string",
"system_settings" : {
"debug_enabled" : true,
"elasticsearch_password" : "string",
"elasticsearch_url" : "string",
"elasticsearch_username" : "string",
"kibana_url" : "string",
"secret_token" : "string"
},
"user_settings_json" : {},
"user_settings_override_json" : {},
"user_settings_override_yaml" : "string",
"user_settings_yaml" : "string",
"version" : "string"
},
"cluster_topology" : [
{
"apm" : null,
"instance_configuration_id" : "string",
"size" : {
"resource" : "string",
"value" : 0
},
"zone_count" : 0
}
],
"transient" : {
"plan_configuration" : {
"calm_wait_time" : 0,
"cluster_reboot" : "string",
"extended_maintenance" : true,
"move_allocators" : [
{
"allocator_down" : true,
"from" : "string",
"to" : [
"string"
]
}
],
"move_instances" : [
{
"from" : "string",
"instance_down" : true,
"to" : [
"string"
]
}
],
"preferred_allocators" : [
"string"
],
"reallocate_instances" : true,
"timeout" : 0
},
"strategy" : {
"grow_and_shrink" : {},
"rolling" : {
"allow_inline_resize" : true,
"group_by" : "string",
"shard_init_wait_time" : 0,
"skip_synced_flush" : true
},
"rolling_grow_and_shrink" : {}
}
}
}
}
'