Skip to main content
POST
/
deployments
Create Deployment
curl --request POST \
  --url https://api.elastic-cloud.com/api/v1/deployments \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "alias": "<string>",
  "metadata": {
    "tags": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "name": "<string>",
  "region": "<string>",
  "resources": {
    "apm": [
      {
        "display_name": "<string>",
        "elasticsearch_cluster_ref_id": "<string>",
        "plan": {
          "apm": {
            "docker_image": "<string>",
            "system_settings": {
              "debug_enabled": "<boolean>",
              "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": {
                "docker_image": "<string>",
                "system_settings": {
                  "debug_enabled": "<boolean>",
                  "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>"
              },
              "instance_configuration_id": "<string>",
              "instance_configuration_version": "<integer>",
              "size": {
                "resource": "memory",
                "value": "<integer>"
              },
              "zone_count": "<integer>"
            }
          ],
          "transient": {
            "plan_configuration": {
              "calm_wait_time": "<long>",
              "cluster_reboot": "forced",
              "extended_maintenance": "<boolean>",
              "timeout": "<long>"
            },
            "strategy": {
              "autodetect": {},
              "grow_and_shrink": {},
              "rolling": {
                "allow_inline_resize": "<boolean>",
                "group_by": "<string>",
                "shard_init_wait_time": "<long>",
                "skip_synced_flush": "<boolean>"
              },
              "rolling_grow_and_shrink": {}
            }
          }
        },
        "ref_id": "<string>",
        "region": "<string>",
        "settings": {
          "metadata": {
            "name": "<string>"
          }
        }
      }
    ],
    "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": {
                "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>"
              },
              "instance_configuration_id": "<string>",
              "instance_configuration_version": "<integer>",
              "node_type": {
                "appserver": "<boolean>",
                "worker": "<boolean>"
              },
              "size": {
                "resource": "storage",
                "value": "<integer>"
              },
              "zone_count": "<integer>"
            }
          ],
          "transient": {
            "plan_configuration": {
              "calm_wait_time": "<long>",
              "cluster_reboot": "forced",
              "extended_maintenance": "<boolean>",
              "move_allocators": [
                {
                  "allocator_down": "<boolean>",
                  "from": "<string>",
                  "to": [
                    "<string>"
                  ]
                }
              ],
              "move_instances": [
                {
                  "from": "<string>",
                  "instance_down": "<boolean>",
                  "to": [
                    "<string>"
                  ]
                }
              ],
              "preferred_allocators": [
                "<string>"
              ],
              "reallocate_instances": "<boolean>",
              "timeout": "<long>"
            },
            "strategy": {
              "autodetect": {},
              "grow_and_shrink": {},
              "rolling": {
                "allow_inline_resize": "<boolean>",
                "group_by": "<string>",
                "shard_init_wait_time": "<long>",
                "skip_synced_flush": "<boolean>"
              },
              "rolling_grow_and_shrink": {}
            }
          }
        },
        "ref_id": "<string>",
        "region": "<string>",
        "settings": {
          "metadata": {
            "name": "<string>"
          }
        }
      }
    ],
    "elasticsearch": [
      {
        "display_name": "<string>",
        "plan": {
          "autoscaling_enabled": "<boolean>",
          "cluster_topology": [
            {
              "autoscaling_max": {
                "resource": "storage",
                "value": "<integer>"
              },
              "autoscaling_min": {
                "resource": "memory",
                "value": "<integer>"
              },
              "autoscaling_policy_override_json": {},
              "autoscaling_tier_override": "<boolean>",
              "elasticsearch": {
                "curation": {
                  "from_instance_configuration_id": "<string>",
                  "to_instance_configuration_id": "<string>"
                },
                "docker_image": "<string>",
                "enabled_built_in_plugins": [
                  "<string>"
                ],
                "node_attributes": {
                  "aliquip5": "<string>",
                  "dolor1": "<string>"
                },
                "system_settings": {
                  "auto_create_index": "<boolean>",
                  "default_shards_per_index": "<integer>",
                  "destructive_requires_name": "<boolean>",
                  "enable_close_index": "<boolean>",
                  "monitoring_collection_interval": "<integer>",
                  "monitoring_history_duration": "<string>",
                  "reindex_whitelist": [
                    "<string>"
                  ],
                  "scripting": {
                    "expressions_enabled": "<boolean>",
                    "file": {
                      "enabled": "<boolean>",
                      "sandbox_mode": "<boolean>"
                    },
                    "inline": {
                      "enabled": "<boolean>",
                      "sandbox_mode": "<boolean>"
                    },
                    "mustache_enabled": "<boolean>",
                    "painless_enabled": "<boolean>",
                    "stored": {
                      "enabled": "<boolean>",
                      "sandbox_mode": "<boolean>"
                    }
                  },
                  "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>"
              },
              "id": "<string>",
              "instance_configuration_id": "<string>",
              "instance_configuration_version": "<integer>",
              "node_roles": [
                "data_content"
              ],
              "node_type": {
                "data": "<boolean>",
                "ingest": "<boolean>",
                "master": "<boolean>",
                "ml": "<boolean>"
              },
              "size": {
                "resource": "memory",
                "value": "<integer>"
              },
              "topology_element_control": {
                "min": {
                  "resource": "storage",
                  "value": "<integer>"
                }
              },
              "zone_count": "<integer>"
            }
          ],
          "deployment_template": {
            "id": "<string>",
            "version": "<string>"
          },
          "elasticsearch": {
            "curation": {
              "from_instance_configuration_id": "<string>",
              "to_instance_configuration_id": "<string>"
            },
            "docker_image": "<string>",
            "enabled_built_in_plugins": [
              "<string>"
            ],
            "node_attributes": {
              "aliqua_2": "<string>",
              "esta36": "<string>"
            },
            "system_settings": {
              "auto_create_index": "<boolean>",
              "default_shards_per_index": "<integer>",
              "destructive_requires_name": "<boolean>",
              "enable_close_index": "<boolean>",
              "monitoring_collection_interval": "<integer>",
              "monitoring_history_duration": "<string>",
              "reindex_whitelist": [
                "<string>"
              ],
              "scripting": {
                "expressions_enabled": "<boolean>",
                "file": {
                  "enabled": "<boolean>",
                  "sandbox_mode": "<boolean>"
                },
                "inline": {
                  "enabled": "<boolean>",
                  "sandbox_mode": "<boolean>"
                },
                "mustache_enabled": "<boolean>",
                "painless_enabled": "<boolean>",
                "stored": {
                  "enabled": "<boolean>",
                  "sandbox_mode": "<boolean>"
                }
              },
              "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>"
          },
          "transient": {
            "cluster_settings_json": {},
            "plan_configuration": {
              "calm_wait_time": "<long>",
              "cluster_reboot": "forced",
              "extended_maintenance": "<boolean>",
              "max_snapshot_age": "<long>",
              "max_snapshot_attempts": "<integer>",
              "skip_snapshot": "<boolean>",
              "timeout": "<long>"
            },
            "remote_clusters": {
              "resources": [
                {
                  "alias": "<string>",
                  "deployment_id": "<string>",
                  "elasticsearch_ref_id": "<string>",
                  "info": {
                    "compatible": "<boolean>",
                    "connected": "<boolean>",
                    "healthy": "<boolean>",
                    "trusted": "<boolean>",
                    "trusted_back": "<boolean>"
                  },
                  "skip_unavailable": "<boolean>"
                }
              ]
            },
            "restore_snapshot": {
              "repository_config": {
                "raw_settings": {}
              },
              "repository_name": "<string>",
              "restore_payload": {
                "indices": [
                  "<string>"
                ],
                "raw_settings": {}
              },
              "snapshot_name": "<string>",
              "source_cluster_id": "<string>",
              "strategy": "full"
            },
            "strategy": {
              "autodetect": {},
              "grow_and_shrink": {},
              "rolling": {
                "allow_inline_resize": "<boolean>",
                "group_by": "<string>",
                "shard_init_wait_time": "<long>",
                "skip_synced_flush": "<boolean>"
              },
              "rolling_grow_and_shrink": {}
            }
          }
        },
        "ref_id": "<string>",
        "region": "<string>",
        "settings": {
          "curation": {
            "specs": [
              {
                "index_pattern": "<string>",
                "trigger_interval_seconds": "<integer>"
              }
            ]
          },
          "dedicated_masters_threshold": "<integer>",
          "keystore_contents": {
            "secrets": {
              "Lorem_c80": {
                "as_file": "<boolean>",
                "value": {}
              },
              "officia_0c3": {
                "as_file": "<boolean>",
                "value": {}
              }
            }
          },
          "metadata": {
            "name": "<string>"
          },
          "monitoring": {
            "target_cluster_id": "<string>"
          },
          "snapshot": {
            "cron_expression": "<string>",
            "interval": "<string>",
            "retention": {
              "max_age": "<string>",
              "snapshots": "<integer>"
            }
          },
          "traffic_filter": {
            "rulesets": [
              "<string>"
            ]
          },
          "trust": {
            "accounts": [
              {
                "account_id": "<string>",
                "name": "<string>",
                "trust_all": "<boolean>",
                "trust_allowlist": [
                  "<string>"
                ]
              }
            ],
            "direct": [
              {
                "additional_node_names": [
                  "<string>"
                ],
                "certificates": [
                  {
                    "metadata": {
                      "also_trusted_by": [
                        "<string>"
                      ],
                      "fingerprint": "<string>",
                      "valid_from": "<dateTime>",
                      "valid_to": "<dateTime>"
                    },
                    "pem": "<string>"
                  }
                ],
                "name": "<string>",
                "scope_id": "<string>",
                "trust_all": "<boolean>",
                "trust_allowlist": [
                  "<string>"
                ],
                "type": "ECE",
                "uid": "<string>"
              }
            ],
            "external": [
              {
                "name": "<string>",
                "trust_all": "<boolean>",
                "trust_allowlist": [
                  "<string>"
                ],
                "trust_relationship_id": "<string>"
              }
            ]
          }
        }
      }
    ],
    "enterprise_search": [
      {
        "display_name": "<string>",
        "elasticsearch_cluster_ref_id": "<string>",
        "plan": {
          "cluster_topology": [
            {
              "allocator_filter": {},
              "enterprise_search": {
                "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>"
              },
              "instance_configuration_id": "<string>",
              "instance_configuration_version": "<integer>",
              "memory_per_node": {},
              "node_configuration": "<string>",
              "node_count_per_zone": {},
              "node_type": {
                "appserver": "<boolean>",
                "connector": "<boolean>",
                "worker": "<boolean>"
              },
              "size": {
                "resource": "storage",
                "value": "<integer>"
              },
              "zone_count": "<integer>"
            }
          ],
          "enterprise_search": {
            "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>"
          },
          "transient": {
            "plan_configuration": {
              "calm_wait_time": "<long>",
              "cluster_reboot": "forced",
              "extended_maintenance": "<boolean>",
              "move_allocators": [
                {
                  "allocator_down": "<boolean>",
                  "from": "<string>",
                  "to": [
                    "<string>"
                  ]
                }
              ],
              "move_instances": [
                {
                  "from": "<string>",
                  "instance_down": "<boolean>",
                  "to": [
                    "<string>"
                  ]
                }
              ],
              "preferred_allocators": [
                "<string>"
              ],
              "reallocate_instances": "<boolean>",
              "timeout": "<long>"
            },
            "strategy": {
              "autodetect": {},
              "grow_and_shrink": {},
              "rolling": {
                "allow_inline_resize": "<boolean>",
                "group_by": "<string>",
                "shard_init_wait_time": "<long>",
                "skip_synced_flush": "<boolean>"
              },
              "rolling_grow_and_shrink": {}
            }
          }
        },
        "ref_id": "<string>",
        "region": "<string>",
        "settings": {
          "metadata": {
            "name": "<string>"
          }
        }
      }
    ],
    "integrations_server": [
      {
        "display_name": "<string>",
        "elasticsearch_cluster_ref_id": "<string>",
        "plan": {
          "cluster_topology": [
            {
              "instance_configuration_id": "<string>",
              "instance_configuration_version": "<integer>",
              "integrations_server": {
                "docker_image": "<string>",
                "mode": "managed",
                "system_settings": {
                  "debug_enabled": "<boolean>",
                  "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>"
              },
              "size": {
                "resource": "storage",
                "value": "<integer>"
              },
              "zone_count": "<integer>"
            }
          ],
          "integrations_server": {
            "docker_image": "<string>",
            "mode": "standalone",
            "system_settings": {
              "debug_enabled": "<boolean>",
              "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>"
          },
          "transient": {
            "plan_configuration": {
              "calm_wait_time": "<long>",
              "cluster_reboot": "forced",
              "extended_maintenance": "<boolean>",
              "timeout": "<long>"
            },
            "strategy": {
              "autodetect": {},
              "grow_and_shrink": {},
              "rolling": {
                "allow_inline_resize": "<boolean>",
                "group_by": "<string>",
                "shard_init_wait_time": "<long>",
                "skip_synced_flush": "<boolean>"
              },
              "rolling_grow_and_shrink": {}
            }
          }
        },
        "ref_id": "<string>",
        "region": "<string>",
        "settings": {
          "metadata": {
            "name": "<string>"
          }
        }
      }
    ],
    "kibana": [
      {
        "display_name": "<string>",
        "elasticsearch_cluster_ref_id": "<string>",
        "plan": {
          "cluster_topology": [
            {
              "instance_configuration_id": "<string>",
              "instance_configuration_version": "<integer>",
              "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>"
              },
              "size": {
                "resource": "storage",
                "value": "<integer>"
              },
              "zone_count": "<integer>"
            }
          ],
          "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>"
          },
          "transient": {
            "plan_configuration": {
              "calm_wait_time": "<long>",
              "cluster_reboot": "forced",
              "extended_maintenance": "<boolean>",
              "timeout": "<long>"
            },
            "strategy": {
              "autodetect": {},
              "grow_and_shrink": {},
              "rolling": {
                "allow_inline_resize": "<boolean>",
                "group_by": "<string>",
                "shard_init_wait_time": "<long>",
                "skip_synced_flush": "<boolean>"
              },
              "rolling_grow_and_shrink": {}
            }
          }
        },
        "ref_id": "<string>",
        "region": "<string>",
        "settings": {
          "metadata": {
            "name": "<string>"
          }
        }
      }
    ]
  },
  "settings": {
    "autoscaling_enabled": "<boolean>",
    "observability": {
      "logging": {
        "destination": {
          "deployment_id": "<string>",
          "ref_id": "<string>"
        }
      },
      "metrics": {
        "destination": {
          "deployment_id": "<string>",
          "ref_id": "<string>"
        }
      }
    },
    "traffic_filter_settings": {
      "rulesets": [
        "<string>"
      ]
    }
  },
  "version": "<string>"
}'
{
  "alias": "<string>",
  "created": "<boolean>",
  "diagnostics": {
    "creates": {
      "apm": [
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        },
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        }
      ],
      "appsearch": [
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        },
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        }
      ],
      "elasticsearch": [
        {
          "backend_plan": {},
          "display_name": "<string>",
          "ref_id": "<string>"
        },
        {
          "backend_plan": {},
          "display_name": "<string>",
          "ref_id": "<string>"
        }
      ],
      "enterprise_search": [
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        },
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        }
      ],
      "integrations_server": [
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        },
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        }
      ],
      "kibana": [
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        },
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        }
      ]
    },
    "updates": {
      "apm": [
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        },
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        }
      ],
      "appsearch": [
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        },
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        }
      ],
      "elasticsearch": [
        {
          "backend_plan": {},
          "display_name": "<string>",
          "ref_id": "<string>"
        },
        {
          "backend_plan": {},
          "display_name": "<string>",
          "ref_id": "<string>"
        }
      ],
      "enterprise_search": [
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        },
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        }
      ],
      "integrations_server": [
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        },
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        }
      ],
      "kibana": [
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        },
        {
          "backend_plan": {},
          "display_name": "<string>",
          "elasticsearch_cluster_ref_id": "<string>",
          "ref_id": "<string>"
        }
      ]
    }
  },
  "id": "<string>",
  "name": "<string>",
  "resources": [
    {
      "cloud_id": "<string>",
      "credentials": {
        "password": "<string>",
        "username": "<string>"
      },
      "elasticsearch_cluster_ref_id": "<string>",
      "id": "<string>",
      "kind": "<string>",
      "ref_id": "<string>",
      "region": "<string>",
      "secret_token": "<string>",
      "warnings": [
        {
          "code": "<string>",
          "message": "<string>"
        },
        {
          "code": "<string>",
          "message": "<string>"
        }
      ]
    },
    {
      "cloud_id": "<string>",
      "credentials": {
        "password": "<string>",
        "username": "<string>"
      },
      "elasticsearch_cluster_ref_id": "<string>",
      "id": "<string>",
      "kind": "<string>",
      "ref_id": "<string>",
      "region": "<string>",
      "secret_token": "<string>",
      "warnings": [
        {
          "code": "<string>",
          "message": "<string>"
        },
        {
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Query Parameters

request_id
string

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)

Example:

"<string>"

validate_only
string

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

Example:

"false"

template_id
string

An optional template id - if present, the referenced template will be used to fill in the resources field of the deployment creation request. If any resources are present in the request together with the template, the ones coming in the request will prevail and no merging with the template will be performed.

Example:

"<string>"

Body

application/json
alias
string
Example:

"<string>"

metadata
object
name
string
Example:

"<string>"

region
string
Example:

"<string>"

resources
object
settings
object
version
string
Example:

"<string>"

Response

The request was valid (used when validate_only is true).

alias
string
Example:

"<string>"

created
string
Example:

"<boolean>"

diagnostics
object
id
string
Example:

"<string>"

name
string
Example:

"<string>"

resources
object[]
Example:
[
{
"cloud_id": "<string>",
"credentials": {
"password": "<string>",
"username": "<string>"
},
"elasticsearch_cluster_ref_id": "<string>",
"id": "<string>",
"kind": "<string>",
"ref_id": "<string>",
"region": "<string>",
"secret_token": "<string>",
"warnings": [
{ "code": "<string>", "message": "<string>" },
{ "code": "<string>", "message": "<string>" }
]
},
{
"cloud_id": "<string>",
"credentials": {
"password": "<string>",
"username": "<string>"
},
"elasticsearch_cluster_ref_id": "<string>",
"id": "<string>",
"kind": "<string>",
"ref_id": "<string>",
"region": "<string>",
"secret_token": "<string>",
"warnings": [
{ "code": "<string>", "message": "<string>" },
{ "code": "<string>", "message": "<string>" }
]
}
]
I