---
title: "POST /environments"
method: POST
path: "/environments"
---

# POST /environments

`POST /environments`

Creates a runtime environment for a given runtime engine.

## Request body

- object
  - `clientToken` string — A client token is a unique, case-sensitive string of up to 128 ASCII characters with ASCII values of 33-126 inclusive. It is generated by the client to ensure idempotent operations, allowing safe retries without unintended side effects.
  - `description` string — The description of the runtime environment.
  - `engineType` 'microfocus' | 'bluage', required — The engine type for the runtime environment.
  - `engineVersion` string — The version of the engine type for the runtime environment.
  - `highAvailabilityConfig` object — Defines the details of a high availability configuration.
    - `desiredCapacity` integer — The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.
  - `instanceType` string, required — The type of instance for the runtime environment.
  - `kmsKeyId` string — The identifier of a customer managed key.
  - `name` string, required — The name of the runtime environment. Must be unique within the account.
  - `networkType` 'ipv4' | 'dual' — The network type required for the runtime environment.
  - `preferredMaintenanceWindow` string — <p>Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format <code>ddd:hh24:mi-ddd:hh24:mi</code> and must be less than 24 hours. The following two examples are valid maintenance windows: <code>sun:23:45-mon:00:15</code> or <code>sat:01:00-sat:03:00</code>. </p> <p>If you do not provide a value, a random system-generated value will be assigned.</p>
  - `publiclyAccessible` boolean — Specifies whether the runtime environment is publicly accessible.
  - `securityGroupIds` String50[] — The list of security groups for the VPC associated with this runtime environment.
  - `storageConfigurations` StorageConfiguration[] — Optional. The storage configurations for this runtime environment.
    - `efs` object — Defines the storage configuration for an Amazon EFS file system.
      - `fileSystemId` string, required — The file system identifier.
      - `mountPoint` string, required — The mount point for the file system.
    - `fsx` object — Defines the storage configuration for an Amazon FSx file system.
      - `fileSystemId` string, required — The file system identifier.
      - `mountPoint` string, required — The mount point for the file system.
  - `subnetIds` String50[] — The list of subnets associated with the VPC for this runtime environment.
  - `tags` object — The tags for the runtime environment.

## Response `200`

Success

- CreateEnvironmentResponse
  - `environmentId` string, required — The unique identifier of the runtime environment.

## Other responses

- `480` — ServiceQuotaExceededException
- `481` — ThrottlingException
- `482` — AccessDeniedException
- `483` — ConflictException
- `484` — ValidationException
- `485` — InternalServerException

---

[API](https://skmtc.net/aws/apis/m2.md) · [All operations](https://skmtc.net/aws/apis/m2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/m2/versions/aac43e95a42b/schema)