Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1437198164.5 KB

Creates a runtime environment for a given runtime engine.

post/environments

Request body

clientTokenstring

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.

descriptionstring

The description of the runtime environment.

engineType'microfocus' | 'bluage' required

The engine type for the runtime environment.

engineVersionstring

The version of the engine type for the runtime environment.

instanceTypestring required

The type of instance for the runtime environment.

kmsKeyIdstring

The identifier of a customer managed key.

namestring required

The name of the runtime environment. Must be unique within the account.

networkType'ipv4' | 'dual'

The network type required for the runtime environment.

preferredMaintenanceWindowstring
<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>
publiclyAccessibleboolean

Specifies whether the runtime environment is publicly accessible.

securityGroupIdsString50[]

The list of security groups for the VPC associated with this runtime environment.

subnetIdsString50[]

The list of subnets associated with the VPC for this runtime environment.

tagsobject

The tags for the runtime environment.

Response

Success

environmentIdstring required

The unique identifier of the runtime environment.