Skip to content

Create a new application

POST
/api/v3/organizations/{organisation}/applications

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation ID

Request Body required

object
appName
required

Application name

string
my-app
composeDefinition
required
object
containers
Array<object>
object
name
required

Name of the container

string
/^[a-zA-Z0-9_-]+$/
imageReference
required
object
type
required

Specifies whether the image is internal (ECR) or external (e.g., Docker Hub)

string
Allowed values: internal external
identifier
required

The image identifier. For ‘internal’ type, this is the image tag. For ‘external’ type, this is the full image name.

string
cpu

Container-level CPU units

integer
nullable
memory

Container-level memory hard limit (MiB)

integer
nullable
memoryReservation

Container-level memory soft limit (MiB)

integer
nullable
exposedPorts

List of container ports to expose

Array<integer>
nullable
mountPoints
Array<object>
nullable
object
sourceVolume
required

The name of the logical volume

string
containerPath
required

The path inside the container where the volume is mounted

string
readOnly
boolean
environment

Environment variables specific to this container

Array<object>
nullable
object
name
required

Environment variable name

string
value
required

Environment variable value

string
secrets

Secrets mapped to environment variables

Array<object>
nullable
object
name
required

The environment variable name to be set in the container

string
valueFrom
required

The key of the secret in the environment’s ‘app-secrets’ store

string
healthCheck

Container health check configuration

object
command

The command to run to determine if the container is healthy

Array<string>
interval

Time period (seconds) between health checks

integer
default: 30 >= 5 <= 300
timeout

Time period (seconds) to wait for a health check to return

integer
default: 5 >= 2 <= 60
retries

Number of times to retry a failed health check

integer
default: 3 >= 1 <= 10
startPeriod

Grace period (seconds) to ignore unhealthy checks after container starts

integer
nullable <= 300
dependsOn

Container startup dependencies

Array<object>
nullable
object
containerName
required

The name of the container this container depends on

string
condition

The condition to wait for on the dependency

string
Allowed values: START HEALTHY COMPLETE SUCCESS
command
Array<string>
nullable
entryPoint
Array<string>
nullable
workingDirectory
string
nullable
essential
boolean
default: true nullable
readonlyRootFilesystem
boolean
nullable
user
string
nullable
originProtection

Enable origin protection for all exposed ports on this container

boolean
nullable
architecture
string
taskCpu
integer
taskMemory
integer
taskRoleArn
string
minCapacity
integer
maxCapacity
integer
minCapacity

Minimum task count for auto-scaling

integer
default: 1 nullable
maxCapacity

Maximum task count for auto-scaling

integer
default: 1 nullable
database

Optional database configuration

object
engine

Database engine type (MySQL 8.4, Postgres)

string
default: mysql
Allowed values: mysql postgres
instanceClass

RDS instance class

string
default: db.t4g.micro
db.t4g.micro
storageGb

Allocated storage in GiB

integer
default: 20
20
multiAz

Enable Multi-AZ deployment (higher availability and cost)

boolean
filesystem

Optional filesystem configuration

object
required

Whether to create a shared filesystem

boolean
default: true
mountPath

Mount path inside containers

string
default: /mnt/data
/data/shared

Responses

201

The created application

object
appName
required

Application name

string
organisation
required

Organisation machine name

string
database

Database configuration

object
rdsInstanceIdentifier

RDS instance identifier

string
rdsInstanceEndpoint

RDS instance endpoint address

string
rdsInstanceEngine

Database engine

string
Allowed values: mysql postgres
rdsInstanceStatus

RDS instance status

string
filesystem

Filesystem configuration

object
filesystemId

EFS filesystem ID

string
mountPath

Default mount path in containers

string
composeDefinition
object
containers
Array<object>
object
name
required

Name of the container

string
/^[a-zA-Z0-9_-]+$/
imageReference
required
object
type
required

Specifies whether the image is internal (ECR) or external (e.g., Docker Hub)

string
Allowed values: internal external
identifier
required

The image identifier. For ‘internal’ type, this is the image tag. For ‘external’ type, this is the full image name.

string
cpu

Container-level CPU units

integer
nullable
memory

Container-level memory hard limit (MiB)

integer
nullable
memoryReservation

Container-level memory soft limit (MiB)

integer
nullable
exposedPorts

List of container ports to expose

Array<integer>
nullable
mountPoints
Array<object>
nullable
object
sourceVolume
required

The name of the logical volume

string
containerPath
required

The path inside the container where the volume is mounted

string
readOnly
boolean
environment

Environment variables specific to this container

Array<object>
nullable
object
name
required

Environment variable name

string
value
required

Environment variable value

string
secrets

Secrets mapped to environment variables

Array<object>
nullable
object
name
required

The environment variable name to be set in the container

string
valueFrom
required

The key of the secret in the environment’s ‘app-secrets’ store

string
healthCheck

Container health check configuration

object
command

The command to run to determine if the container is healthy

Array<string>
interval

Time period (seconds) between health checks

integer
default: 30 >= 5 <= 300
timeout

Time period (seconds) to wait for a health check to return

integer
default: 5 >= 2 <= 60
retries

Number of times to retry a failed health check

integer
default: 3 >= 1 <= 10
startPeriod

Grace period (seconds) to ignore unhealthy checks after container starts

integer
nullable <= 300
dependsOn

Container startup dependencies

Array<object>
nullable
object
containerName
required

The name of the container this container depends on

string
condition

The condition to wait for on the dependency

string
Allowed values: START HEALTHY COMPLETE SUCCESS
command
Array<string>
nullable
entryPoint
Array<string>
nullable
workingDirectory
string
nullable
essential
boolean
default: true nullable
readonlyRootFilesystem
boolean
nullable
user
string
nullable
originProtection

Enable origin protection for all exposed ports on this container

boolean
nullable
architecture
string
taskCpu
integer
taskMemory
integer
taskRoleArn
string
minCapacity
integer
maxCapacity
integer
status

Application status

string
nullable
deploymentInformation

Deployment history

Array<object>
nullable
object
deploymentId

Deployment identifier

string
taskDefinitionArn

Task definition ARN used

string
createdAt

Deployment creation timestamp

string format: date-time
status

Deployment status

string
imageTag

Image tag deployed

string
imageReference

Image reference information

object
type

Image type

string
Allowed values: internal external
identifier

Image identifier

string
containerNames

List of container names

Array<string>
nullable
minCapacity

Minimum task count for auto-scaling

integer
nullable
maxCapacity

Maximum task count for auto-scaling

integer
nullable
desiredCount

Desired task count

integer
nullable
runningCount

Currently running task count

integer
nullable
environments

List of environments

Array<object>
nullable
object
envName

Environment name

string
status

Environment status

string
runningCount

Running task count

integer
desiredCount

Desired task count

integer

400

The request is invalid