Get a single environment

GET

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

const url = 'https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/test-env';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/test-env \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

organisation

required

string

The organisation ID

Example

test-org

application

required

string

The application ID

Example

test-app

environment

required

string

The environment ID

Example

test-env

Responses

200

The environment with runtime details

application/json

Environment response schema with runtime details

object

envName

required

Environment name

string

status

Environment status

string

runningCount

Number of running tasks

integer

desiredCount

Desired number of tasks

integer

minCapacity

Minimum capacity for autoscaling

integer

maxCapacity

Maximum capacity for autoscaling

integer

publicIpAddress

Public IP address for SSH access

string

nullable

deploymentStatus

Current deployment status

string

Allowed values: COMPLETED IN_PROGRESS FAILED

deploymentFailureType

Why the most recent task stopped. SPOT_INTERRUPTION is informational: the cloud provider reclaimed the task and the platform replaces it.

string

nullable

Allowed values: IMAGE_NOT_FOUND ACCESS_DENIED ARCHITECTURE_MISMATCH RESOURCE_LIMIT SPOT_INTERRUPTION OTHER

deploymentFailureReason

Reason for deployment failure

string

nullable

taskDefinition

Task definition details

object

service

Container service details

object

loadBalancer

Load balancer configuration

object

securityGroup

Security group configuration

object

subnet

Subnet configuration

object

vpc

VPC configuration

object

containerNames

Container name list

Array<string>

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

description

string

nullable

scheduleExpression

string

command

Array<string>

targetContainerName

string

nullable

isEnabled

boolean

lastRun

The newest run of the job. Null when the job has never run. Sent by the cron list.

object

runId

string

status

FAILED_TO_START: the task could not be launched, so the command never ran (for example, the job targets a container that no longer exists).

string

Allowed values: PENDING RUNNING SUCCEEDED FAILED FAILED_TO_START EXPIRED TIMED_OUT

createdAt

string format: date-time

nullable

exitCode

integer

nullable

errorMessage

Why the run failed, in plain text. Set when the status is FAILED_TO_START.

string

nullable

consecutiveFailures

Failed runs (FAILED or FAILED_TO_START) from the newest run back to the first run that did not fail, counted over the latest 10 runs. 0 when the newest run did not fail. Sent by the cron list.

integer

<= 10

albRouting

Load balancer routing configuration

object

createdAt

Creation timestamp

string format: date-time

updatedAt

Last update timestamp

string format: date-time

Example

{
  "envName": "production",
  "status": "ACTIVE",
  "runningCount": 2,
  "desiredCount": 2,
  "minCapacity": 1,
  "maxCapacity": 5,
  "publicIpAddress": "54.123.45.67",
  "deploymentStatus": "COMPLETED",
  "deploymentFailureType": "IMAGE_NOT_FOUND",
  "cron": [
    {
      "lastRun": {
        "status": "PENDING"
      },
      "consecutiveFailures": 0
    }
  ]
}

404

The environment not found