Create a new environment
POST /api/v3/organizations/{organisation}/applications/{application}/environments
Authorizations
Parameters
Path Parameters
The organisation ID
The application ID
Request Body required
object
Environment name (e.g., ‘staging’, ‘development’)
Minimum number of instances
Maximum number of instances
Clone configuration from an existing environment
object
object
Name of the container
object
Specifies whether the image is internal (ECR) or external (e.g., Docker Hub)
The image identifier. For ‘internal’ type, this is the image tag. For ‘external’ type, this is the full image name.
Container-level CPU units
Container-level memory hard limit (MiB)
Container-level memory soft limit (MiB)
List of container ports to expose
object
The name of the logical volume
The path inside the container where the volume is mounted
Environment variables specific to this container
object
Environment variable name
Environment variable value
Secrets mapped to environment variables
object
The environment variable name to be set in the container
The key of the secret in the environment’s ‘app-secrets’ store
Container health check configuration
object
The command to run to determine if the container is healthy
Time period (seconds) between health checks
Time period (seconds) to wait for a health check to return
Number of times to retry a failed health check
Grace period (seconds) to ignore unhealthy checks after container starts
Container startup dependencies
object
The name of the container this container depends on
The condition to wait for on the dependency
Enable origin protection for all exposed ports on this container
CPU architecture (X86_64 or ARM64)
Task-level CPU units (e.g., 256, 512, 1024)
Task-level memory in MB
Minimum number of instances
Maximum number of instances
Spot instance strategy configuration for controlling cost vs reliability. Spot instances provide significant cost savings (~70%) but may be interrupted by AWS. Available for non-production environments.
object
Spot instance strategy. ‘off’ = On-Demand only (highest reliability, no savings). ‘spot-only’ = 100% Spot instances (~70% savings, default for non-prod). ‘mixed-safe’ = 50% Spot instances (~35% savings, requires multiple instances). ‘mixed-aggressive’ = 80% Spot instances (~56% savings, requires multiple instances).
spot-onlyOptional. Enable cross-environment networking within the same application. When false (default): Uses shared security group for complete isolation (most secure). When true: Uses app-specific security group to enable communication between environments of the same application (e.g., staging can connect to production database). Note: If enableCrossAppNetworking is true, this setting is overridden.
Optional. Enable cross-application networking within the same organization. When false (default): Uses shared/app-specific security group based on enableCrossEnvNetworking. When true: Uses org-specific security group to enable container-to-container communication with ALL applications in the same organization via service discovery (microservices architecture). This setting takes priority over enableCrossEnvNetworking.
Optional image tag suffix for cloning
Spot instance strategy configuration for controlling cost vs reliability. Spot instances provide significant cost savings (~70%) but may be interrupted by AWS. Available for non-production environments.
object
Spot instance strategy. ‘off’ = On-Demand only (highest reliability, no savings). ‘spot-only’ = 100% Spot instances (~70% savings, default for non-prod). ‘mixed-safe’ = 50% Spot instances (~35% savings, requires multiple instances). ‘mixed-aggressive’ = 80% Spot instances (~56% savings, requires multiple instances).
spot-onlyEnvironment variables to inject
object
Variable name
Variable value
Whether to merge environment variables with cloned ones (true) or replace them (false). Default: false
Responses
201
The environment created
Environment response schema with runtime details
object
Environment name
productionEnvironment status
ACTIVENumber of running tasks
2Desired number of tasks
2Minimum capacity for autoscaling
1Maximum capacity for autoscaling
5Public IP address for SSH access
54.123.45.67Deployment status
COMPLETEDECS task definition details
object
ECS service details
object
Load balancer configuration
object
Security group configuration
object
Subnet configuration
object
VPC configuration
object
Container configurations
object
Persistent storage volumes
object
Scheduled cron jobs
object
ALB routing configuration
object
Creation timestamp
Last update timestamp
400
The environment data is invalid
403
Environment limit reached - application has reached the maximum number of allowed environments
object
Environment limit reachedApplication my-app has reached the maximum number of allowed environments (5/5). Please contact support to increase your limit.