Deployment - CRUD

List Deployments

List Deployments.

Request

GET /api/v1/deployments

Responses

200
(DeploymentsListResponse) The list of deployments that belong to the authenticated user
401
(BasicFailedReply) You are not authorized to perform this action

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/deployments \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Create Deployment

Creates a Deployment.

Request

POST /api/v1/deployments

Query parameters

NameTypeRequiredDescription

request_id

string

N

An optional idempotency token - if two create requests share the same request_id token (min size 32 characters, max 128) then only one deployment will be created, the second request will return the info of that deployment (in the same format described below, but with blanks for auth-related fields)

validate_only

boolean; default: false

N

If true, will just validate the Deployment definition but will not perform the creation

Request body

(DeploymentCreateRequest) (required) The deployment definition

Responses

200
(DeploymentCreateResponse) The request was valid and a new deployment was created
202
(DeploymentCreateResponse) The request was valid
400
(BasicFailedReply) The deployment request had errors
401
(BasicFailedReply) You are not authorized to perform this action

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/deployments \
-H "Authorization: ApiKey $CLOUD_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "metadata" : {
      "system_owned" : true
   },
   "name" : "string",
   "resources" : {
      "apm" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_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" : {}
                  }
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : {
                  "contact_email" : "string",
                  "hidden" : true,
                  "name" : "string",
                  "owner_id" : "string",
                  "resources" : {
                     "cpu" : {
                        "boost" : true,
                        "hard_limit" : true
                     }
                  },
                  "subscription_level" : "string",
                  "system_owned" : true
               }
            }
         }
      ],
      "appsearch" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "plan" : {
               "appsearch" : {
                  "docker_image" : "string",
                  "system_settings" : {
                     "elasticsearch_password" : "string",
                     "elasticsearch_url" : "string",
                     "elasticsearch_username" : "string",
                     "secret_session_key" : "string"
                  },
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "cluster_topology" : [
                  {
                     "appsearch" : null,
                     "instance_configuration_id" : "string",
                     "node_type" : {
                        "appserver" : true,
                        "worker" : true
                     },
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "move_allocators" : [
                        null
                     ],
                     "move_instances" : [
                        null
                     ],
                     "preferred_allocators" : [
                        "string"
                     ],
                     "reallocate_instances" : true,
                     "timeout" : 0
                  },
                  "strategy" : null
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : null
            }
         }
      ],
      "elasticsearch" : [
         {
            "display_name" : "string",
            "plan" : {
               "cluster_topology" : [
                  {
                     "allocator_filter" : {},
                     "elasticsearch" : {
                        "curation" : {
                           "from_instance_configuration_id" : "string",
                           "to_instance_configuration_id" : "string"
                        },
                        "docker_image" : "string",
                        "enabled_built_in_plugins" : [
                           "string"
                        ],
                        "node_attributes" : {
                           "some_property" : "string"
                        },
                        "system_settings" : {
                           "auto_create_index" : true,
                           "default_shards_per_index" : 0,
                           "destructive_requires_name" : true,
                           "enable_close_index" : true,
                           "monitoring_collection_interval" : 0,
                           "monitoring_history_duration" : "string",
                           "reindex_whitelist" : [
                              "string"
                           ],
                           "scripting" : {
                              "expressions_enabled" : true,
                              "file" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              },
                              "inline" : null,
                              "mustache_enabled" : true,
                              "painless_enabled" : true,
                              "stored" : null
                           },
                           "use_disk_threshold" : true,
                           "watcher_trigger_engine" : "string"
                        },
                        "user_bundles" : [
                           {
                              "elasticsearch_version" : "string",
                              "name" : "string",
                              "url" : "string"
                           }
                        ],
                        "user_plugins" : [
                           {
                              "elasticsearch_version" : "string",
                              "name" : "string",
                              "url" : "string"
                           }
                        ],
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "instance_configuration_id" : "string",
                     "memory_per_node" : 0,
                     "node_configuration" : "string",
                     "node_count_per_zone" : 0,
                     "node_type" : {
                        "data" : true,
                        "ingest" : true,
                        "master" : true,
                        "ml" : true
                     },
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "deployment_template" : {
                  "id" : "string",
                  "version" : "string"
               },
               "elasticsearch" : null,
               "tiebreaker_override" : true,
               "tiebreaker_topology" : {
                  "memory_per_node" : 0
               },
               "transient" : {
                  "cluster_settings_json" : {},
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "max_snapshot_age" : 0,
                     "max_snapshot_attempts" : 0,
                     "move_allocators" : [
                        null
                     ],
                     "move_instances" : [
                        null
                     ],
                     "move_only" : true,
                     "override_failsafe" : true,
                     "preferred_allocators" : [
                        "string"
                     ],
                     "reallocate_instances" : true,
                     "skip_data_migration" : true,
                     "skip_post_upgrade_steps" : true,
                     "skip_snapshot" : true,
                     "skip_snapshot_post_major_upgrade" : true,
                     "skip_upgrade_checker" : true,
                     "timeout" : 0
                  },
                  "restore_snapshot" : {
                     "repository_config" : {
                        "raw_settings" : {}
                     },
                     "repository_name" : "string",
                     "restore_payload" : {
                        "indices" : [
                           "string"
                        ],
                        "raw_settings" : {}
                     },
                     "snapshot_name" : "string",
                     "source_cluster_id" : "string",
                     "strategy" : "string"
                  },
                  "strategy" : null
               },
               "zone_count" : 0
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "ccs" : {
                  "remote_clusters" : {
                     "some_property" : {
                        "cluster_id" : "string",
                        "skip_unavailable" : true
                     }
                  }
               },
               "curation" : {
                  "specs" : [
                     {
                        "index_pattern" : "string",
                        "trigger_interval_seconds" : 0
                     }
                  ]
               },
               "dedicated_masters_threshold" : 0,
               "ip_filtering" : {
                  "rulesets" : [
                     "string"
                  ]
               },
               "metadata" : null,
               "monitoring" : {
                  "target_cluster_id" : "string"
               },
               "snapshot" : {
                  "enabled" : true,
                  "interval" : "string",
                  "pending_interval" : "string",
                  "repository" : {
                     "default" : {},
                     "reference" : {
                        "repository_name" : "string"
                     },
                     "static" : {
                        "repository_type" : "string",
                        "settings" : {}
                     }
                  },
                  "repository_name" : "string",
                  "retention" : {
                     "max_age" : "string",
                     "snapshots" : 0
                  },
                  "suspended" : [
                     "string"
                  ],
                  "wait_time_after_snapshotting" : "string"
               }
            }
         }
      ],
      "kibana" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "plan" : {
               "cluster_topology" : [
                  {
                     "allocator_filter" : {},
                     "instance_configuration_id" : "string",
                     "kibana" : {
                        "docker_image" : "string",
                        "system_settings" : {
                           "elasticsearch_password" : "string",
                           "elasticsearch_url" : "string",
                           "elasticsearch_username" : "string"
                        },
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "memory_per_node" : 0,
                     "node_configuration" : "string",
                     "node_count_per_zone" : 0,
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "kibana" : null,
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "move_allocators" : [
                        null
                     ],
                     "move_instances" : [
                        null
                     ],
                     "preferred_allocators" : [
                        "string"
                     ],
                     "reallocate_instances" : true,
                     "timeout" : 0
                  },
                  "strategy" : null
               },
               "zone_count" : 0
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : null
            }
         }
      ]
   },
   "settings" : {
      "ip_filtering_settings" : null
   }
}
'

Delete Deployment

Deletes a Deployment and all its resources.

Request

DELETE /api/v1/deployments/{deployment_id}

Path parameters

NameTypeRequiredDescription

deployment_id

string

Y

Identifier for the Deployment

Responses

200
(DeploymentDeleteResponse) The request was valid and the deployment was deleted
400
(BasicFailedReply) The Deployment resources have not been shutdown yet
401
(BasicFailedReply) You are not authorized to perform this action
404
(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XDELETE {{hostname}}/api/v1/deployments/{deployment_id} \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Get Deployment

Retrieves information about a Deployment.

Request

GET /api/v1/deployments/{deployment_id}

Path parameters

NameTypeRequiredDescription

deployment_id

string

Y

Identifier for the Deployment

Query parameters

NameTypeRequiredDescription

convert_legacy_plans

boolean; default: false

N

If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true')

enrich_with_template

boolean; default: true

N

If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on

show_metadata

boolean; default: false

N

Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials

show_plan_defaults

boolean; default: false

N

If showing plans, whether to show values that are left at their default value (less readable but more informative)

show_plan_history

boolean; default: false

N

Whether to include with the current and pending plan information the plan history- can be very large per cluster

show_plan_logs

boolean; default: false

N

Whether to include with the current and pending plan information the attempt log - can be very large per cluster

show_plans

boolean; default: true

N

Whether to include the full current and pending plan information in the response - can be large per cluster

show_security

boolean; default: false

N

Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials

show_settings

boolean; default: false

N

Whether to show cluster settings in the response.

show_system_alerts

integer; default: 0

N

Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.

Responses

200

(DeploymentGetResponse) The Deployment info response

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
401
(BasicFailedReply) You are not authorized to perform this action
404
(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found
500
(BasicFailedReply) We have failed you.

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/deployments/{deployment_id} \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Update Deployment

Updates a Deployment.

Request

PUT /api/v1/deployments/{deployment_id}

Path parameters

NameTypeRequiredDescription

deployment_id

string

Y

Identifier for the Deployment

Query parameters

NameTypeRequiredDescription

hide_pruned_orphans

boolean; default: false

N

Whether or not to hide orphaned resources that were shut down (relevant if prune on the request is true)

skip_snapshot

boolean; default: false

N

Whether or not to skip snapshots before shutting down orphaned resources (relevant if prune on the request is true)

validate_only

boolean; default: false

N

If true, will just validate the Deployment definition but will not perform the update

version

integer

N

If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

Request body

(DeploymentUpdateRequest) (required) The deployment definition

Responses

200

(DeploymentUpdateResponse) The request was valid and the deployment was updated

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
400
(BasicFailedReply) The deployment request had errors
401
(BasicFailedReply) You are not authorized to perform this action
404
(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPUT {{hostname}}/api/v1/deployments/{deployment_id} \
-H "Authorization: ApiKey $CLOUD_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "metadata" : {
      "hidden" : true,
      "system_owned" : true
   },
   "name" : "string",
   "prune_orphans" : true,
   "resources" : {
      "apm" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_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" : {}
                  }
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : {
                  "contact_email" : "string",
                  "hidden" : true,
                  "name" : "string",
                  "owner_id" : "string",
                  "resources" : {
                     "cpu" : {
                        "boost" : true,
                        "hard_limit" : true
                     }
                  },
                  "subscription_level" : "string",
                  "system_owned" : true
               }
            }
         }
      ],
      "appsearch" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "plan" : {
               "appsearch" : {
                  "docker_image" : "string",
                  "system_settings" : {
                     "elasticsearch_password" : "string",
                     "elasticsearch_url" : "string",
                     "elasticsearch_username" : "string",
                     "secret_session_key" : "string"
                  },
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "cluster_topology" : [
                  {
                     "appsearch" : null,
                     "instance_configuration_id" : "string",
                     "node_type" : {
                        "appserver" : true,
                        "worker" : true
                     },
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "move_allocators" : [
                        null
                     ],
                     "move_instances" : [
                        null
                     ],
                     "preferred_allocators" : [
                        "string"
                     ],
                     "reallocate_instances" : true,
                     "timeout" : 0
                  },
                  "strategy" : null
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : null
            }
         }
      ],
      "elasticsearch" : [
         {
            "display_name" : "string",
            "plan" : {
               "cluster_topology" : [
                  {
                     "allocator_filter" : {},
                     "elasticsearch" : {
                        "curation" : {
                           "from_instance_configuration_id" : "string",
                           "to_instance_configuration_id" : "string"
                        },
                        "docker_image" : "string",
                        "enabled_built_in_plugins" : [
                           "string"
                        ],
                        "node_attributes" : {
                           "some_property" : "string"
                        },
                        "system_settings" : {
                           "auto_create_index" : true,
                           "default_shards_per_index" : 0,
                           "destructive_requires_name" : true,
                           "enable_close_index" : true,
                           "monitoring_collection_interval" : 0,
                           "monitoring_history_duration" : "string",
                           "reindex_whitelist" : [
                              "string"
                           ],
                           "scripting" : {
                              "expressions_enabled" : true,
                              "file" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              },
                              "inline" : null,
                              "mustache_enabled" : true,
                              "painless_enabled" : true,
                              "stored" : null
                           },
                           "use_disk_threshold" : true,
                           "watcher_trigger_engine" : "string"
                        },
                        "user_bundles" : [
                           {
                              "elasticsearch_version" : "string",
                              "name" : "string",
                              "url" : "string"
                           }
                        ],
                        "user_plugins" : [
                           {
                              "elasticsearch_version" : "string",
                              "name" : "string",
                              "url" : "string"
                           }
                        ],
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "instance_configuration_id" : "string",
                     "memory_per_node" : 0,
                     "node_configuration" : "string",
                     "node_count_per_zone" : 0,
                     "node_type" : {
                        "data" : true,
                        "ingest" : true,
                        "master" : true,
                        "ml" : true
                     },
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "deployment_template" : {
                  "id" : "string",
                  "version" : "string"
               },
               "elasticsearch" : null,
               "tiebreaker_override" : true,
               "tiebreaker_topology" : {
                  "memory_per_node" : 0
               },
               "transient" : {
                  "cluster_settings_json" : {},
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "max_snapshot_age" : 0,
                     "max_snapshot_attempts" : 0,
                     "move_allocators" : [
                        null
                     ],
                     "move_instances" : [
                        null
                     ],
                     "move_only" : true,
                     "override_failsafe" : true,
                     "preferred_allocators" : [
                        "string"
                     ],
                     "reallocate_instances" : true,
                     "skip_data_migration" : true,
                     "skip_post_upgrade_steps" : true,
                     "skip_snapshot" : true,
                     "skip_snapshot_post_major_upgrade" : true,
                     "skip_upgrade_checker" : true,
                     "timeout" : 0
                  },
                  "restore_snapshot" : {
                     "repository_config" : {
                        "raw_settings" : {}
                     },
                     "repository_name" : "string",
                     "restore_payload" : {
                        "indices" : [
                           "string"
                        ],
                        "raw_settings" : {}
                     },
                     "snapshot_name" : "string",
                     "source_cluster_id" : "string",
                     "strategy" : "string"
                  },
                  "strategy" : null
               },
               "zone_count" : 0
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "ccs" : {
                  "remote_clusters" : {
                     "some_property" : {
                        "cluster_id" : "string",
                        "skip_unavailable" : true
                     }
                  }
               },
               "curation" : {
                  "specs" : [
                     {
                        "index_pattern" : "string",
                        "trigger_interval_seconds" : 0
                     }
                  ]
               },
               "dedicated_masters_threshold" : 0,
               "ip_filtering" : {
                  "rulesets" : [
                     "string"
                  ]
               },
               "metadata" : null,
               "monitoring" : {
                  "target_cluster_id" : "string"
               },
               "snapshot" : {
                  "enabled" : true,
                  "interval" : "string",
                  "pending_interval" : "string",
                  "repository" : {
                     "default" : {},
                     "reference" : {
                        "repository_name" : "string"
                     },
                     "static" : {
                        "repository_type" : "string",
                        "settings" : {}
                     }
                  },
                  "repository_name" : "string",
                  "retention" : {
                     "max_age" : "string",
                     "snapshots" : 0
                  },
                  "suspended" : [
                     "string"
                  ],
                  "wait_time_after_snapshotting" : "string"
               }
            }
         }
      ],
      "kibana" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "plan" : {
               "cluster_topology" : [
                  {
                     "allocator_filter" : {},
                     "instance_configuration_id" : "string",
                     "kibana" : {
                        "docker_image" : "string",
                        "system_settings" : {
                           "elasticsearch_password" : "string",
                           "elasticsearch_url" : "string",
                           "elasticsearch_username" : "string"
                        },
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "memory_per_node" : 0,
                     "node_configuration" : "string",
                     "node_count_per_zone" : 0,
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "kibana" : null,
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "move_allocators" : [
                        null
                     ],
                     "move_instances" : [
                        null
                     ],
                     "preferred_allocators" : [
                        "string"
                     ],
                     "reallocate_instances" : true,
                     "timeout" : 0
                  },
                  "strategy" : null
               },
               "zone_count" : 0
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : null
            }
         }
      ]
   }
}
'

Restores a shutdown Deployment

Restores all resources in a Deployment.

Request

POST /api/v1/deployments/{deployment_id}/_restore

Path parameters

NameTypeRequiredDescription

deployment_id

string

Y

Identifier for the Deployment

Query parameters

NameTypeRequiredDescription

restore_snapshot

boolean; default: false

N

Whether or not to restore a snapshot for those resources that allow it.

Responses

200
(DeploymentRestoreResponse) The request was valid and the resources of the deployment were restored
400
(BasicFailedReply) There are Elasticsearch resources in the deployment which are not shut down
401
(BasicFailedReply) You are not authorized to perform this action
404
(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/deployments/{deployment_id}/_restore \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Shuts down Deployment

Shuts down all resources in a Deployment.

Request

POST /api/v1/deployments/{deployment_id}/_shutdown

Path parameters

NameTypeRequiredDescription

deployment_id

string

Y

Identifier for the Deployment

Query parameters

NameTypeRequiredDescription

hide

boolean; default: false

N

Whether or not to hide the deployment and its resources

skip_snapshot

boolean; default: false

N

Whether or not to skip snapshots before shutting down the resources

Responses

200
(DeploymentShutdownResponse) The request was valid and the resources of the deployment were shutdown
400
(BasicFailedReply) The deployment request had errors
401
(BasicFailedReply) You are not authorized to perform this action
404
(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/deployments/{deployment_id}/_shutdown \
-H "Authorization: ApiKey $CLOUD_API_KEY"