QOqovery
Applications

Create an application

post/environment/{environmentId}/application

Request

Path parameters

environmentIdstring uuid required

Environment ID

Request body

namestring required

name is case insensitive

descriptionstring nullable

give a description to this application

build_mode'DOCKER'

DOCKER requires dockerfile_path

dockerfile_pathstring nullable

The path of the associated Dockerfile. Only if you are using build_mode = DOCKER

cpuinteger

unit is millicores (m). 1000m = 1 cpu

memoryinteger

unit is MB. 1024 MB = 1GB

gpuinteger
min_running_instancesinteger

Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no application running.

max_running_instancesinteger

Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit.

auto_previewboolean

Specify if the environment preview option is activated or not for this application.
If activated, a preview environment will be automatically cloned at each pull request.
If not specified, it takes the value of the auto_preview property from the associated environment.

argumentsstring[]
entrypointstring

optional entrypoint when launching container

auto_deployboolean nullable

Specify if the application will be automatically updated after receiving a new commit.

icon_uristring uri

Icon URI representing the application.

docker_target_build_stagestring nullable

The target build stage in the Dockerfile to build

Example request

{
  "storage": [
    {
      "size": 16,
      "mount_point": "/mnt/images"
    }
  ],
  "ports": [
    {
      "internal_port": 8080,
      "external_port": 8080
    }
  ],
  "git_repository": {
    "url": "https://github.com/Qovery/simple-node-app",
    "branch": "feat/text_xxx"
  },
  "cpu": 1250,
  "memory": 1024,
  "gpu": 1
}

Response

Create application

idstring uuid required
created_atstring date-time required
updated_atstring date-time
maximum_cpuinteger

Maximum cpu that can be allocated to the application based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu

maximum_memoryinteger

Maximum memory that can be allocated to the application based on organization cluster configuration. unit is MB. 1024 MB = 1GB

maximun_gpuinteger
namestring required

name is case insensitive

descriptionstring

give a description to this application

build_mode'DOCKER'

DOCKER requires dockerfile_path

dockerfile_pathstring nullable

The path of the associated Dockerfile. Only if you are using build_mode = DOCKER

cpuinteger

unit is millicores (m). 1000m = 1 cpu

memoryinteger

unit is MB. 1024 MB = 1GB

gpuinteger
min_running_instancesinteger

Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no application running.

max_running_instancesinteger

Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit.

auto_previewboolean

Specify if the environment preview option is activated or not for this application.
If activated, a preview environment will be automatically cloned at each pull request.
If not specified, it takes the value of the auto_preview property from the associated environment.

argumentsstring[]
entrypointstring

optional entrypoint when launching container

auto_deployboolean

Specify if the application will be automatically updated after receiving a new commit.

icon_uristring uri required

Icon URI representing the application.

service_type'APPLICATION' | 'DATABASE' | 'CONTAINER' | 'JOB' | 'HELM' | 'TERRAFORM' required

type of the service (application, database, job, ...)

docker_target_build_stagestring nullable

The target build stage in the Dockerfile to build

Example response

{
  "storage": [
    {
      "size": 16,
      "mount_point": "/mnt/images"
    }
  ],
  "git_repository": {
    "owner": "John Doe",
    "name": "simple-node-app",
    "deployed_commit_tag": "v1.0.1"
  },
  "maximum_cpu": 16000,
  "maximum_memory": 16384,
  "cpu": 1250,
  "memory": 1024,
  "ports": [
    {
      "internal_port": 8080,
      "external_port": 8080
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.