Skip to content
QuantCDN

Get a single environment

GET
/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation ID

application
required
string

The application ID

environment
required
string

The environment ID

Responses

200

The environment with runtime details

Environment response schema with runtime details

object
envName
required

Environment name

string
production
status

Environment status

string
ACTIVE
runningCount

Number of running tasks

integer
2
desiredCount

Desired number of tasks

integer
2
minCapacity

Minimum capacity for autoscaling

integer
1
maxCapacity

Maximum capacity for autoscaling

integer
5
publicIpAddress

Public IP address for SSH access

string
nullable 
54.123.45.67
deploymentStatus

Current deployment status. FAILED indicates the most recent deployment did not complete successfully.

string
Allowed values: COMPLETED IN_PROGRESS FAILED 
COMPLETED
deploymentFailureType

Type of deployment failure when deploymentStatus is FAILED (e.g., ‘ECS_DEPLOYMENT_CIRCUIT_BREAKER’, ‘IMAGE_PULL_ERROR’)

string
nullable 
IMAGE_PULL_ERROR
deploymentFailureReason

Human-readable explanation of why the deployment failed. Contains details such as wrong image architecture, missing image, or container startup errors.

string
nullable 
CannotPullContainerError: pull image manifest has been retried 5 times
taskDefinition

ECS task definition details

object
service

ECS service details

object
loadBalancer

Load balancer configuration

object
securityGroup

Security group configuration

object
subnet

Subnet configuration

object
vpc

VPC configuration

object
containers

Container configurations

Array<object>
object
volumes

Persistent storage volumes

Array<object>
object
volumeId
string
volumeName
string
description
string
environmentEfsId
string
createdAt
string
rootDirectory
string
accessPointId
string
accessPointArn
string
cron

Scheduled cron jobs

Array<object>
object
name
string
schedule
string
command
string
albRouting

ALB routing configuration

object
createdAt

Creation timestamp

string format: date-time
updatedAt

Last update timestamp

string format: date-time

404

The environment not found