# Create Deployment

**POST /deployments**

Creates a Deployment.


## Servers
- https://api.elastic-cloud.com/api/v1: https://api.elastic-cloud.com/api/v1 ()



## Parameters


### 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)
- **validate_only** (boolean)
  If true, will just validate the Deployment definition but will not perform the creation
- **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.

### Body: application/json (object)
The deployment definition
- **name** (string)
  A name for the deployment; otherwise this will be the generated deployment id
- **resources** (object)
  Describes the resources that will belong to a Deployment
- **settings** (object)
  Additional configuration for the new deployment object.
- **metadata** (object)
  Additional information about the new deployment object.
- **alias** (string)
  A user-defined alias to use in place of Cluster IDs for user-friendly URLs
- **region** (string)
  Identifier of the region to be used as the default for all the resources of the deployment
- **version** (string)
  The version for all the resources of the deployment (must be one of the supported versions). Defaults to the latest version if not specified.


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

#### Body: application/json (object)
- **id** (string)
  The id of the deployment
- **name** (string)
  The name of the deployment
- **alias** (string)
  A user-defined deployment alias for user-friendly resource URLs
- **created** (boolean)
  Whether or not the deployment was freshly created
- **resources** (array[object])
  List of created resources.
- **diagnostics** (object)
  Describes the diagnostics for a given Deployment-modifying payload

### 201
The request was valid and a new deployment was created
#### Headers
- **x-cloud-resource-version** (string)
  The resource version, which is used to avoid update conflicts with concurrent operations
- **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)

#### Body: application/json (object)
- **id** (string)
  The id of the deployment
- **name** (string)
  The name of the deployment
- **alias** (string)
  A user-defined deployment alias for user-friendly resource URLs
- **created** (boolean)
  Whether or not the deployment was freshly created
- **resources** (array[object])
  List of created resources.
- **diagnostics** (object)
  Describes the diagnostics for a given Deployment-modifying payload

### 202
The request was valid and deployment creation had already been started.

#### Body: application/json (object)
- **id** (string)
  The id of the deployment
- **name** (string)
  The name of the deployment
- **alias** (string)
  A user-defined deployment alias for user-friendly resource URLs
- **created** (boolean)
  Whether or not the deployment was freshly created
- **resources** (array[object])
  List of created resources.
- **diagnostics** (object)
  Describes the diagnostics for a given Deployment-modifying payload

### 400
The deployment request had errors.

#### Body: application/json (object)
- **errors** (array[object])
  A list of errors that occurred in the failing request

### 401
You are not authorized to perform this action.

#### Body: application/json (object)
- **errors** (array[object])
  A list of errors that occurred in the failing request


[Powered by Bump.sh](https://bump.sh)