Create a container
curl --request POST \
--url https://api.qovery.com/environment/{environmentId}/container \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"registry_id": "<string>",
"image_name": "<string>",
"tag": "<string>",
"healthchecks": {
"readiness_probe": {
"type": {
"tcp": {
"port": 123,
"host": null
},
"http": {
"path": "/",
"scheme": "HTTP",
"port": 123
},
"exec": {
"command": [
"sh",
"-c",
"test -f /tmp/healthy"
]
},
"grpc": {
"service": null,
"port": 123
}
},
"initial_delay_seconds": 30,
"period_seconds": 10,
"timeout_seconds": 5,
"success_threshold": 1,
"failure_threshold": 9
},
"liveness_probe": {
"type": {
"tcp": {
"port": 123,
"host": null
},
"http": {
"path": "/",
"scheme": "HTTP",
"port": 123
},
"exec": {
"command": [
"sh",
"-c",
"test -f /tmp/healthy"
]
},
"grpc": {
"service": null,
"port": 123
}
},
"initial_delay_seconds": 30,
"period_seconds": 10,
"timeout_seconds": 5,
"success_threshold": 1,
"failure_threshold": 9
}
},
"storage": [
{
"type": "FAST_SSD",
"size": 16,
"mount_point": "/mnt/images",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"ports": [
{
"internal_port": 8080,
"publicly_accessible": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"external_port": 8080,
"is_default": true,
"protocol": "HTTP",
"public_path": "<string>",
"public_path_rewrite": "<string>"
}
],
"description": "<string>",
"arguments": [
"<string>"
],
"entrypoint": "<string>",
"cpu": 1250,
"memory": 1024,
"gpu": 1,
"ephemeral_storage_in_gib": 10,
"min_running_instances": 1,
"max_running_instances": 1,
"auto_preview": true,
"auto_deploy": true,
"annotations_groups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"labels_groups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"icon_uri": "<string>"
}
'import requests
url = "https://api.qovery.com/environment/{environmentId}/container"
payload = {
"name": "<string>",
"registry_id": "<string>",
"image_name": "<string>",
"tag": "<string>",
"healthchecks": {
"readiness_probe": {
"type": {
"tcp": {
"port": 123,
"host": None
},
"http": {
"path": "/",
"scheme": "HTTP",
"port": 123
},
"exec": { "command": ["sh", "-c", "test -f /tmp/healthy"] },
"grpc": {
"service": None,
"port": 123
}
},
"initial_delay_seconds": 30,
"period_seconds": 10,
"timeout_seconds": 5,
"success_threshold": 1,
"failure_threshold": 9
},
"liveness_probe": {
"type": {
"tcp": {
"port": 123,
"host": None
},
"http": {
"path": "/",
"scheme": "HTTP",
"port": 123
},
"exec": { "command": ["sh", "-c", "test -f /tmp/healthy"] },
"grpc": {
"service": None,
"port": 123
}
},
"initial_delay_seconds": 30,
"period_seconds": 10,
"timeout_seconds": 5,
"success_threshold": 1,
"failure_threshold": 9
}
},
"storage": [
{
"type": "FAST_SSD",
"size": 16,
"mount_point": "/mnt/images",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"ports": [
{
"internal_port": 8080,
"publicly_accessible": True,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"external_port": 8080,
"is_default": True,
"protocol": "HTTP",
"public_path": "<string>",
"public_path_rewrite": "<string>"
}
],
"description": "<string>",
"arguments": ["<string>"],
"entrypoint": "<string>",
"cpu": 1250,
"memory": 1024,
"gpu": 1,
"ephemeral_storage_in_gib": 10,
"min_running_instances": 1,
"max_running_instances": 1,
"auto_preview": True,
"auto_deploy": True,
"annotations_groups": [{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }],
"labels_groups": [{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }],
"icon_uri": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
registry_id: '<string>',
image_name: '<string>',
tag: '<string>',
healthchecks: {
readiness_probe: {
type: {
tcp: {port: 123, host: null},
http: {path: '/', scheme: 'HTTP', port: 123},
exec: {command: ['sh', '-c', 'test -f /tmp/healthy']},
grpc: {service: null, port: 123}
},
initial_delay_seconds: 30,
period_seconds: 10,
timeout_seconds: 5,
success_threshold: 1,
failure_threshold: 9
},
liveness_probe: {
type: {
tcp: {port: 123, host: null},
http: {path: '/', scheme: 'HTTP', port: 123},
exec: {command: ['sh', '-c', 'test -f /tmp/healthy']},
grpc: {service: null, port: 123}
},
initial_delay_seconds: 30,
period_seconds: 10,
timeout_seconds: 5,
success_threshold: 1,
failure_threshold: 9
}
},
storage: [
{
type: 'FAST_SSD',
size: 16,
mount_point: '/mnt/images',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
ports: [
{
internal_port: 8080,
publicly_accessible: true,
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
external_port: 8080,
is_default: true,
protocol: 'HTTP',
public_path: '<string>',
public_path_rewrite: '<string>'
}
],
description: '<string>',
arguments: ['<string>'],
entrypoint: '<string>',
cpu: 1250,
memory: 1024,
gpu: 1,
ephemeral_storage_in_gib: 10,
min_running_instances: 1,
max_running_instances: 1,
auto_preview: true,
auto_deploy: true,
annotations_groups: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
labels_groups: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
icon_uri: '<string>'
})
};
fetch('https://api.qovery.com/environment/{environmentId}/container', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qovery.com/environment/{environmentId}/container",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'registry_id' => '<string>',
'image_name' => '<string>',
'tag' => '<string>',
'healthchecks' => [
'readiness_probe' => [
'type' => [
'tcp' => [
'port' => 123,
'host' => null
],
'http' => [
'path' => '/',
'scheme' => 'HTTP',
'port' => 123
],
'exec' => [
'command' => [
'sh',
'-c',
'test -f /tmp/healthy'
]
],
'grpc' => [
'service' => null,
'port' => 123
]
],
'initial_delay_seconds' => 30,
'period_seconds' => 10,
'timeout_seconds' => 5,
'success_threshold' => 1,
'failure_threshold' => 9
],
'liveness_probe' => [
'type' => [
'tcp' => [
'port' => 123,
'host' => null
],
'http' => [
'path' => '/',
'scheme' => 'HTTP',
'port' => 123
],
'exec' => [
'command' => [
'sh',
'-c',
'test -f /tmp/healthy'
]
],
'grpc' => [
'service' => null,
'port' => 123
]
],
'initial_delay_seconds' => 30,
'period_seconds' => 10,
'timeout_seconds' => 5,
'success_threshold' => 1,
'failure_threshold' => 9
]
],
'storage' => [
[
'type' => 'FAST_SSD',
'size' => 16,
'mount_point' => '/mnt/images',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'ports' => [
[
'internal_port' => 8080,
'publicly_accessible' => true,
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'external_port' => 8080,
'is_default' => true,
'protocol' => 'HTTP',
'public_path' => '<string>',
'public_path_rewrite' => '<string>'
]
],
'description' => '<string>',
'arguments' => [
'<string>'
],
'entrypoint' => '<string>',
'cpu' => 1250,
'memory' => 1024,
'gpu' => 1,
'ephemeral_storage_in_gib' => 10,
'min_running_instances' => 1,
'max_running_instances' => 1,
'auto_preview' => true,
'auto_deploy' => true,
'annotations_groups' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'labels_groups' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'icon_uri' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.qovery.com/environment/{environmentId}/container"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"registry_id\": \"<string>\",\n \"image_name\": \"<string>\",\n \"tag\": \"<string>\",\n \"healthchecks\": {\n \"readiness_probe\": {\n \"type\": {\n \"tcp\": {\n \"port\": 123,\n \"host\": null\n },\n \"http\": {\n \"path\": \"/\",\n \"scheme\": \"HTTP\",\n \"port\": 123\n },\n \"exec\": {\n \"command\": [\n \"sh\",\n \"-c\",\n \"test -f /tmp/healthy\"\n ]\n },\n \"grpc\": {\n \"service\": null,\n \"port\": 123\n }\n },\n \"initial_delay_seconds\": 30,\n \"period_seconds\": 10,\n \"timeout_seconds\": 5,\n \"success_threshold\": 1,\n \"failure_threshold\": 9\n },\n \"liveness_probe\": {\n \"type\": {\n \"tcp\": {\n \"port\": 123,\n \"host\": null\n },\n \"http\": {\n \"path\": \"/\",\n \"scheme\": \"HTTP\",\n \"port\": 123\n },\n \"exec\": {\n \"command\": [\n \"sh\",\n \"-c\",\n \"test -f /tmp/healthy\"\n ]\n },\n \"grpc\": {\n \"service\": null,\n \"port\": 123\n }\n },\n \"initial_delay_seconds\": 30,\n \"period_seconds\": 10,\n \"timeout_seconds\": 5,\n \"success_threshold\": 1,\n \"failure_threshold\": 9\n }\n },\n \"storage\": [\n {\n \"type\": \"FAST_SSD\",\n \"size\": 16,\n \"mount_point\": \"/mnt/images\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"ports\": [\n {\n \"internal_port\": 8080,\n \"publicly_accessible\": true,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"external_port\": 8080,\n \"is_default\": true,\n \"protocol\": \"HTTP\",\n \"public_path\": \"<string>\",\n \"public_path_rewrite\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"arguments\": [\n \"<string>\"\n ],\n \"entrypoint\": \"<string>\",\n \"cpu\": 1250,\n \"memory\": 1024,\n \"gpu\": 1,\n \"ephemeral_storage_in_gib\": 10,\n \"min_running_instances\": 1,\n \"max_running_instances\": 1,\n \"auto_preview\": true,\n \"auto_deploy\": true,\n \"annotations_groups\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"labels_groups\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"icon_uri\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.qovery.com/environment/{environmentId}/container")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"registry_id\": \"<string>\",\n \"image_name\": \"<string>\",\n \"tag\": \"<string>\",\n \"healthchecks\": {\n \"readiness_probe\": {\n \"type\": {\n \"tcp\": {\n \"port\": 123,\n \"host\": null\n },\n \"http\": {\n \"path\": \"/\",\n \"scheme\": \"HTTP\",\n \"port\": 123\n },\n \"exec\": {\n \"command\": [\n \"sh\",\n \"-c\",\n \"test -f /tmp/healthy\"\n ]\n },\n \"grpc\": {\n \"service\": null,\n \"port\": 123\n }\n },\n \"initial_delay_seconds\": 30,\n \"period_seconds\": 10,\n \"timeout_seconds\": 5,\n \"success_threshold\": 1,\n \"failure_threshold\": 9\n },\n \"liveness_probe\": {\n \"type\": {\n \"tcp\": {\n \"port\": 123,\n \"host\": null\n },\n \"http\": {\n \"path\": \"/\",\n \"scheme\": \"HTTP\",\n \"port\": 123\n },\n \"exec\": {\n \"command\": [\n \"sh\",\n \"-c\",\n \"test -f /tmp/healthy\"\n ]\n },\n \"grpc\": {\n \"service\": null,\n \"port\": 123\n }\n },\n \"initial_delay_seconds\": 30,\n \"period_seconds\": 10,\n \"timeout_seconds\": 5,\n \"success_threshold\": 1,\n \"failure_threshold\": 9\n }\n },\n \"storage\": [\n {\n \"type\": \"FAST_SSD\",\n \"size\": 16,\n \"mount_point\": \"/mnt/images\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"ports\": [\n {\n \"internal_port\": 8080,\n \"publicly_accessible\": true,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"external_port\": 8080,\n \"is_default\": true,\n \"protocol\": \"HTTP\",\n \"public_path\": \"<string>\",\n \"public_path_rewrite\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"arguments\": [\n \"<string>\"\n ],\n \"entrypoint\": \"<string>\",\n \"cpu\": 1250,\n \"memory\": 1024,\n \"gpu\": 1,\n \"ephemeral_storage_in_gib\": 10,\n \"min_running_instances\": 1,\n \"max_running_instances\": 1,\n \"auto_preview\": true,\n \"auto_deploy\": true,\n \"annotations_groups\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"labels_groups\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"icon_uri\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/environment/{environmentId}/container")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"registry_id\": \"<string>\",\n \"image_name\": \"<string>\",\n \"tag\": \"<string>\",\n \"healthchecks\": {\n \"readiness_probe\": {\n \"type\": {\n \"tcp\": {\n \"port\": 123,\n \"host\": null\n },\n \"http\": {\n \"path\": \"/\",\n \"scheme\": \"HTTP\",\n \"port\": 123\n },\n \"exec\": {\n \"command\": [\n \"sh\",\n \"-c\",\n \"test -f /tmp/healthy\"\n ]\n },\n \"grpc\": {\n \"service\": null,\n \"port\": 123\n }\n },\n \"initial_delay_seconds\": 30,\n \"period_seconds\": 10,\n \"timeout_seconds\": 5,\n \"success_threshold\": 1,\n \"failure_threshold\": 9\n },\n \"liveness_probe\": {\n \"type\": {\n \"tcp\": {\n \"port\": 123,\n \"host\": null\n },\n \"http\": {\n \"path\": \"/\",\n \"scheme\": \"HTTP\",\n \"port\": 123\n },\n \"exec\": {\n \"command\": [\n \"sh\",\n \"-c\",\n \"test -f /tmp/healthy\"\n ]\n },\n \"grpc\": {\n \"service\": null,\n \"port\": 123\n }\n },\n \"initial_delay_seconds\": 30,\n \"period_seconds\": 10,\n \"timeout_seconds\": 5,\n \"success_threshold\": 1,\n \"failure_threshold\": 9\n }\n },\n \"storage\": [\n {\n \"type\": \"FAST_SSD\",\n \"size\": 16,\n \"mount_point\": \"/mnt/images\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"ports\": [\n {\n \"internal_port\": 8080,\n \"publicly_accessible\": true,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"external_port\": 8080,\n \"is_default\": true,\n \"protocol\": \"HTTP\",\n \"public_path\": \"<string>\",\n \"public_path_rewrite\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"arguments\": [\n \"<string>\"\n ],\n \"entrypoint\": \"<string>\",\n \"cpu\": 1250,\n \"memory\": 1024,\n \"gpu\": 1,\n \"ephemeral_storage_in_gib\": 10,\n \"min_running_instances\": 1,\n \"max_running_instances\": 1,\n \"auto_preview\": true,\n \"auto_deploy\": true,\n \"annotations_groups\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"labels_groups\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"icon_uri\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"image_name": "<string>",
"tag": "<string>",
"registry": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>"
},
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"maximum_cpu": 16000,
"maximum_memory": 16384,
"maximum_gpu": 2,
"name": "<string>",
"cpu": 1250,
"memory": 1024,
"gpu": 1,
"min_running_instances": 1,
"max_running_instances": 1,
"healthchecks": {
"readiness_probe": {
"type": {
"tcp": {
"port": 123,
"host": null
},
"http": {
"path": "/",
"scheme": "HTTP",
"port": 123
},
"exec": {
"command": [
"sh",
"-c",
"test -f /tmp/healthy"
]
},
"grpc": {
"service": null,
"port": 123
}
},
"initial_delay_seconds": 30,
"period_seconds": 10,
"timeout_seconds": 5,
"success_threshold": 1,
"failure_threshold": 9
},
"liveness_probe": {
"type": {
"tcp": {
"port": 123,
"host": null
},
"http": {
"path": "/",
"scheme": "HTTP",
"port": 123
},
"exec": {
"command": [
"sh",
"-c",
"test -f /tmp/healthy"
]
},
"grpc": {
"service": null,
"port": 123
}
},
"initial_delay_seconds": 30,
"period_seconds": 10,
"timeout_seconds": 5,
"success_threshold": 1,
"failure_threshold": 9
}
},
"auto_preview": true,
"icon_uri": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"storage": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "FAST_SSD",
"size": 16,
"mount_point": "/mnt/images"
}
],
"registry_id": "<string>",
"description": "<string>",
"arguments": [
"<string>"
],
"entrypoint": "<string>",
"ephemeral_storage_in_gib": 10,
"ports": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"internal_port": 8080,
"publicly_accessible": true,
"protocol": "HTTP",
"name": "<string>",
"external_port": 8080,
"is_default": true,
"public_path": "<string>",
"public_path_rewrite": "<string>"
}
],
"auto_deploy": true,
"annotations_groups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"annotations": [
{
"key": "<string>",
"value": "<string>"
}
],
"scopes": [],
"updated_at": "2023-11-07T05:31:56Z"
}
],
"labels_groups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"labels": [
{
"key": "<string>",
"value": "<string>",
"propagate_to_cloud_provider": true
}
],
"updated_at": "2023-11-07T05:31:56Z"
}
],
"autoscaling": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "KEDA",
"polling_interval_seconds": 123,
"cooldown_period_seconds": 123,
"scalers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"scaler_type": "<string>",
"enabled": true,
"updated_at": "2023-11-07T05:31:56Z",
"config_json": {},
"config_yaml": "<string>",
"trigger_authentication": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"organization_id": "<string>",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"config_yaml": "<string>"
}
}
],
"updated_at": "2023-11-07T05:31:56Z"
}
}Containers
Create a container
POST
/
environment
/
{environmentId}
/
container
Create a container
curl --request POST \
--url https://api.qovery.com/environment/{environmentId}/container \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"registry_id": "<string>",
"image_name": "<string>",
"tag": "<string>",
"healthchecks": {
"readiness_probe": {
"type": {
"tcp": {
"port": 123,
"host": null
},
"http": {
"path": "/",
"scheme": "HTTP",
"port": 123
},
"exec": {
"command": [
"sh",
"-c",
"test -f /tmp/healthy"
]
},
"grpc": {
"service": null,
"port": 123
}
},
"initial_delay_seconds": 30,
"period_seconds": 10,
"timeout_seconds": 5,
"success_threshold": 1,
"failure_threshold": 9
},
"liveness_probe": {
"type": {
"tcp": {
"port": 123,
"host": null
},
"http": {
"path": "/",
"scheme": "HTTP",
"port": 123
},
"exec": {
"command": [
"sh",
"-c",
"test -f /tmp/healthy"
]
},
"grpc": {
"service": null,
"port": 123
}
},
"initial_delay_seconds": 30,
"period_seconds": 10,
"timeout_seconds": 5,
"success_threshold": 1,
"failure_threshold": 9
}
},
"storage": [
{
"type": "FAST_SSD",
"size": 16,
"mount_point": "/mnt/images",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"ports": [
{
"internal_port": 8080,
"publicly_accessible": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"external_port": 8080,
"is_default": true,
"protocol": "HTTP",
"public_path": "<string>",
"public_path_rewrite": "<string>"
}
],
"description": "<string>",
"arguments": [
"<string>"
],
"entrypoint": "<string>",
"cpu": 1250,
"memory": 1024,
"gpu": 1,
"ephemeral_storage_in_gib": 10,
"min_running_instances": 1,
"max_running_instances": 1,
"auto_preview": true,
"auto_deploy": true,
"annotations_groups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"labels_groups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"icon_uri": "<string>"
}
'import requests
url = "https://api.qovery.com/environment/{environmentId}/container"
payload = {
"name": "<string>",
"registry_id": "<string>",
"image_name": "<string>",
"tag": "<string>",
"healthchecks": {
"readiness_probe": {
"type": {
"tcp": {
"port": 123,
"host": None
},
"http": {
"path": "/",
"scheme": "HTTP",
"port": 123
},
"exec": { "command": ["sh", "-c", "test -f /tmp/healthy"] },
"grpc": {
"service": None,
"port": 123
}
},
"initial_delay_seconds": 30,
"period_seconds": 10,
"timeout_seconds": 5,
"success_threshold": 1,
"failure_threshold": 9
},
"liveness_probe": {
"type": {
"tcp": {
"port": 123,
"host": None
},
"http": {
"path": "/",
"scheme": "HTTP",
"port": 123
},
"exec": { "command": ["sh", "-c", "test -f /tmp/healthy"] },
"grpc": {
"service": None,
"port": 123
}
},
"initial_delay_seconds": 30,
"period_seconds": 10,
"timeout_seconds": 5,
"success_threshold": 1,
"failure_threshold": 9
}
},
"storage": [
{
"type": "FAST_SSD",
"size": 16,
"mount_point": "/mnt/images",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"ports": [
{
"internal_port": 8080,
"publicly_accessible": True,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"external_port": 8080,
"is_default": True,
"protocol": "HTTP",
"public_path": "<string>",
"public_path_rewrite": "<string>"
}
],
"description": "<string>",
"arguments": ["<string>"],
"entrypoint": "<string>",
"cpu": 1250,
"memory": 1024,
"gpu": 1,
"ephemeral_storage_in_gib": 10,
"min_running_instances": 1,
"max_running_instances": 1,
"auto_preview": True,
"auto_deploy": True,
"annotations_groups": [{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }],
"labels_groups": [{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }],
"icon_uri": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
registry_id: '<string>',
image_name: '<string>',
tag: '<string>',
healthchecks: {
readiness_probe: {
type: {
tcp: {port: 123, host: null},
http: {path: '/', scheme: 'HTTP', port: 123},
exec: {command: ['sh', '-c', 'test -f /tmp/healthy']},
grpc: {service: null, port: 123}
},
initial_delay_seconds: 30,
period_seconds: 10,
timeout_seconds: 5,
success_threshold: 1,
failure_threshold: 9
},
liveness_probe: {
type: {
tcp: {port: 123, host: null},
http: {path: '/', scheme: 'HTTP', port: 123},
exec: {command: ['sh', '-c', 'test -f /tmp/healthy']},
grpc: {service: null, port: 123}
},
initial_delay_seconds: 30,
period_seconds: 10,
timeout_seconds: 5,
success_threshold: 1,
failure_threshold: 9
}
},
storage: [
{
type: 'FAST_SSD',
size: 16,
mount_point: '/mnt/images',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
ports: [
{
internal_port: 8080,
publicly_accessible: true,
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
external_port: 8080,
is_default: true,
protocol: 'HTTP',
public_path: '<string>',
public_path_rewrite: '<string>'
}
],
description: '<string>',
arguments: ['<string>'],
entrypoint: '<string>',
cpu: 1250,
memory: 1024,
gpu: 1,
ephemeral_storage_in_gib: 10,
min_running_instances: 1,
max_running_instances: 1,
auto_preview: true,
auto_deploy: true,
annotations_groups: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
labels_groups: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
icon_uri: '<string>'
})
};
fetch('https://api.qovery.com/environment/{environmentId}/container', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qovery.com/environment/{environmentId}/container",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'registry_id' => '<string>',
'image_name' => '<string>',
'tag' => '<string>',
'healthchecks' => [
'readiness_probe' => [
'type' => [
'tcp' => [
'port' => 123,
'host' => null
],
'http' => [
'path' => '/',
'scheme' => 'HTTP',
'port' => 123
],
'exec' => [
'command' => [
'sh',
'-c',
'test -f /tmp/healthy'
]
],
'grpc' => [
'service' => null,
'port' => 123
]
],
'initial_delay_seconds' => 30,
'period_seconds' => 10,
'timeout_seconds' => 5,
'success_threshold' => 1,
'failure_threshold' => 9
],
'liveness_probe' => [
'type' => [
'tcp' => [
'port' => 123,
'host' => null
],
'http' => [
'path' => '/',
'scheme' => 'HTTP',
'port' => 123
],
'exec' => [
'command' => [
'sh',
'-c',
'test -f /tmp/healthy'
]
],
'grpc' => [
'service' => null,
'port' => 123
]
],
'initial_delay_seconds' => 30,
'period_seconds' => 10,
'timeout_seconds' => 5,
'success_threshold' => 1,
'failure_threshold' => 9
]
],
'storage' => [
[
'type' => 'FAST_SSD',
'size' => 16,
'mount_point' => '/mnt/images',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'ports' => [
[
'internal_port' => 8080,
'publicly_accessible' => true,
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'external_port' => 8080,
'is_default' => true,
'protocol' => 'HTTP',
'public_path' => '<string>',
'public_path_rewrite' => '<string>'
]
],
'description' => '<string>',
'arguments' => [
'<string>'
],
'entrypoint' => '<string>',
'cpu' => 1250,
'memory' => 1024,
'gpu' => 1,
'ephemeral_storage_in_gib' => 10,
'min_running_instances' => 1,
'max_running_instances' => 1,
'auto_preview' => true,
'auto_deploy' => true,
'annotations_groups' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'labels_groups' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'icon_uri' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.qovery.com/environment/{environmentId}/container"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"registry_id\": \"<string>\",\n \"image_name\": \"<string>\",\n \"tag\": \"<string>\",\n \"healthchecks\": {\n \"readiness_probe\": {\n \"type\": {\n \"tcp\": {\n \"port\": 123,\n \"host\": null\n },\n \"http\": {\n \"path\": \"/\",\n \"scheme\": \"HTTP\",\n \"port\": 123\n },\n \"exec\": {\n \"command\": [\n \"sh\",\n \"-c\",\n \"test -f /tmp/healthy\"\n ]\n },\n \"grpc\": {\n \"service\": null,\n \"port\": 123\n }\n },\n \"initial_delay_seconds\": 30,\n \"period_seconds\": 10,\n \"timeout_seconds\": 5,\n \"success_threshold\": 1,\n \"failure_threshold\": 9\n },\n \"liveness_probe\": {\n \"type\": {\n \"tcp\": {\n \"port\": 123,\n \"host\": null\n },\n \"http\": {\n \"path\": \"/\",\n \"scheme\": \"HTTP\",\n \"port\": 123\n },\n \"exec\": {\n \"command\": [\n \"sh\",\n \"-c\",\n \"test -f /tmp/healthy\"\n ]\n },\n \"grpc\": {\n \"service\": null,\n \"port\": 123\n }\n },\n \"initial_delay_seconds\": 30,\n \"period_seconds\": 10,\n \"timeout_seconds\": 5,\n \"success_threshold\": 1,\n \"failure_threshold\": 9\n }\n },\n \"storage\": [\n {\n \"type\": \"FAST_SSD\",\n \"size\": 16,\n \"mount_point\": \"/mnt/images\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"ports\": [\n {\n \"internal_port\": 8080,\n \"publicly_accessible\": true,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"external_port\": 8080,\n \"is_default\": true,\n \"protocol\": \"HTTP\",\n \"public_path\": \"<string>\",\n \"public_path_rewrite\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"arguments\": [\n \"<string>\"\n ],\n \"entrypoint\": \"<string>\",\n \"cpu\": 1250,\n \"memory\": 1024,\n \"gpu\": 1,\n \"ephemeral_storage_in_gib\": 10,\n \"min_running_instances\": 1,\n \"max_running_instances\": 1,\n \"auto_preview\": true,\n \"auto_deploy\": true,\n \"annotations_groups\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"labels_groups\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"icon_uri\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.qovery.com/environment/{environmentId}/container")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"registry_id\": \"<string>\",\n \"image_name\": \"<string>\",\n \"tag\": \"<string>\",\n \"healthchecks\": {\n \"readiness_probe\": {\n \"type\": {\n \"tcp\": {\n \"port\": 123,\n \"host\": null\n },\n \"http\": {\n \"path\": \"/\",\n \"scheme\": \"HTTP\",\n \"port\": 123\n },\n \"exec\": {\n \"command\": [\n \"sh\",\n \"-c\",\n \"test -f /tmp/healthy\"\n ]\n },\n \"grpc\": {\n \"service\": null,\n \"port\": 123\n }\n },\n \"initial_delay_seconds\": 30,\n \"period_seconds\": 10,\n \"timeout_seconds\": 5,\n \"success_threshold\": 1,\n \"failure_threshold\": 9\n },\n \"liveness_probe\": {\n \"type\": {\n \"tcp\": {\n \"port\": 123,\n \"host\": null\n },\n \"http\": {\n \"path\": \"/\",\n \"scheme\": \"HTTP\",\n \"port\": 123\n },\n \"exec\": {\n \"command\": [\n \"sh\",\n \"-c\",\n \"test -f /tmp/healthy\"\n ]\n },\n \"grpc\": {\n \"service\": null,\n \"port\": 123\n }\n },\n \"initial_delay_seconds\": 30,\n \"period_seconds\": 10,\n \"timeout_seconds\": 5,\n \"success_threshold\": 1,\n \"failure_threshold\": 9\n }\n },\n \"storage\": [\n {\n \"type\": \"FAST_SSD\",\n \"size\": 16,\n \"mount_point\": \"/mnt/images\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"ports\": [\n {\n \"internal_port\": 8080,\n \"publicly_accessible\": true,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"external_port\": 8080,\n \"is_default\": true,\n \"protocol\": \"HTTP\",\n \"public_path\": \"<string>\",\n \"public_path_rewrite\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"arguments\": [\n \"<string>\"\n ],\n \"entrypoint\": \"<string>\",\n \"cpu\": 1250,\n \"memory\": 1024,\n \"gpu\": 1,\n \"ephemeral_storage_in_gib\": 10,\n \"min_running_instances\": 1,\n \"max_running_instances\": 1,\n \"auto_preview\": true,\n \"auto_deploy\": true,\n \"annotations_groups\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"labels_groups\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"icon_uri\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/environment/{environmentId}/container")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"registry_id\": \"<string>\",\n \"image_name\": \"<string>\",\n \"tag\": \"<string>\",\n \"healthchecks\": {\n \"readiness_probe\": {\n \"type\": {\n \"tcp\": {\n \"port\": 123,\n \"host\": null\n },\n \"http\": {\n \"path\": \"/\",\n \"scheme\": \"HTTP\",\n \"port\": 123\n },\n \"exec\": {\n \"command\": [\n \"sh\",\n \"-c\",\n \"test -f /tmp/healthy\"\n ]\n },\n \"grpc\": {\n \"service\": null,\n \"port\": 123\n }\n },\n \"initial_delay_seconds\": 30,\n \"period_seconds\": 10,\n \"timeout_seconds\": 5,\n \"success_threshold\": 1,\n \"failure_threshold\": 9\n },\n \"liveness_probe\": {\n \"type\": {\n \"tcp\": {\n \"port\": 123,\n \"host\": null\n },\n \"http\": {\n \"path\": \"/\",\n \"scheme\": \"HTTP\",\n \"port\": 123\n },\n \"exec\": {\n \"command\": [\n \"sh\",\n \"-c\",\n \"test -f /tmp/healthy\"\n ]\n },\n \"grpc\": {\n \"service\": null,\n \"port\": 123\n }\n },\n \"initial_delay_seconds\": 30,\n \"period_seconds\": 10,\n \"timeout_seconds\": 5,\n \"success_threshold\": 1,\n \"failure_threshold\": 9\n }\n },\n \"storage\": [\n {\n \"type\": \"FAST_SSD\",\n \"size\": 16,\n \"mount_point\": \"/mnt/images\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"ports\": [\n {\n \"internal_port\": 8080,\n \"publicly_accessible\": true,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"external_port\": 8080,\n \"is_default\": true,\n \"protocol\": \"HTTP\",\n \"public_path\": \"<string>\",\n \"public_path_rewrite\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"arguments\": [\n \"<string>\"\n ],\n \"entrypoint\": \"<string>\",\n \"cpu\": 1250,\n \"memory\": 1024,\n \"gpu\": 1,\n \"ephemeral_storage_in_gib\": 10,\n \"min_running_instances\": 1,\n \"max_running_instances\": 1,\n \"auto_preview\": true,\n \"auto_deploy\": true,\n \"annotations_groups\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"labels_groups\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"icon_uri\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"image_name": "<string>",
"tag": "<string>",
"registry": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>"
},
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"maximum_cpu": 16000,
"maximum_memory": 16384,
"maximum_gpu": 2,
"name": "<string>",
"cpu": 1250,
"memory": 1024,
"gpu": 1,
"min_running_instances": 1,
"max_running_instances": 1,
"healthchecks": {
"readiness_probe": {
"type": {
"tcp": {
"port": 123,
"host": null
},
"http": {
"path": "/",
"scheme": "HTTP",
"port": 123
},
"exec": {
"command": [
"sh",
"-c",
"test -f /tmp/healthy"
]
},
"grpc": {
"service": null,
"port": 123
}
},
"initial_delay_seconds": 30,
"period_seconds": 10,
"timeout_seconds": 5,
"success_threshold": 1,
"failure_threshold": 9
},
"liveness_probe": {
"type": {
"tcp": {
"port": 123,
"host": null
},
"http": {
"path": "/",
"scheme": "HTTP",
"port": 123
},
"exec": {
"command": [
"sh",
"-c",
"test -f /tmp/healthy"
]
},
"grpc": {
"service": null,
"port": 123
}
},
"initial_delay_seconds": 30,
"period_seconds": 10,
"timeout_seconds": 5,
"success_threshold": 1,
"failure_threshold": 9
}
},
"auto_preview": true,
"icon_uri": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"storage": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "FAST_SSD",
"size": 16,
"mount_point": "/mnt/images"
}
],
"registry_id": "<string>",
"description": "<string>",
"arguments": [
"<string>"
],
"entrypoint": "<string>",
"ephemeral_storage_in_gib": 10,
"ports": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"internal_port": 8080,
"publicly_accessible": true,
"protocol": "HTTP",
"name": "<string>",
"external_port": 8080,
"is_default": true,
"public_path": "<string>",
"public_path_rewrite": "<string>"
}
],
"auto_deploy": true,
"annotations_groups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"annotations": [
{
"key": "<string>",
"value": "<string>"
}
],
"scopes": [],
"updated_at": "2023-11-07T05:31:56Z"
}
],
"labels_groups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"labels": [
{
"key": "<string>",
"value": "<string>",
"propagate_to_cloud_provider": true
}
],
"updated_at": "2023-11-07T05:31:56Z"
}
],
"autoscaling": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "KEDA",
"polling_interval_seconds": 123,
"cooldown_period_seconds": 123,
"scalers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"scaler_type": "<string>",
"enabled": true,
"updated_at": "2023-11-07T05:31:56Z",
"config_json": {},
"config_yaml": "<string>",
"trigger_authentication": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"organization_id": "<string>",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"config_yaml": "<string>"
}
}
],
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
bearerAuthApiKeyAuth
JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '
Path Parameters
Environment ID
Body
application/json
name is case insensitive
id of the linked registry
The image name pattern differs according to chosen container registry provider:
ECR:repositorySCALEWAY_CR:namespace/imageDOCKER_HUB:imageorrepository/imagePUBLIC_ECR:registry_alias/repository
tag of the image container
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
give a description to this container
optional entrypoint when launching container
unit is millicores (m). 1000m = 1 cpu
Example:
1250
unit is MB. 1024 MB = 1GB
Example:
1024
Required range:
x >= 0Example:
1
Ephemeral storage of the service in GiB. When omitted, the platform default is used.
Required range:
x >= 0Example:
10
CPU architecture to run this service on. If null, the cluster default architecture is used.
Available options:
AMD64, ARM64 Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no container running.
Required range:
x >= 0Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit.
Indicates if the 'environment preview option' is enabled for this container.
If enabled, a preview environment will be automatically cloned when /preview endpoint is called.
If not specified, it takes the value of the auto_preview property from the associated environment.
Specify if the container will be automatically updated after receiving a new image tag. The new image tag shall be communicated via the "Auto Deploy container" endpoint https://api-doc.qovery.com/#tag/Containers/operation/autoDeployContainerEnvironments
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Icon URI representing the container.
Show child attributes
Show child attributes
Response
Create container
The image name pattern differs according to chosen container registry provider:
ECR:repositorySCALEWAY_CR:namespace/imageDOCKER_HUB:imageorrepository/imagePUBLIC_ECR:registry_alias/repository
tag of the image container
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum cpu that can be allocated to the container based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu
Example:
16000
Maximum memory that can be allocated to the container based on organization cluster configuration. unit is MB. 1024 MB = 1GB
Example:
16384
Maximum memory that can be allocated to the container based on organization cluster configuration. unit is MB. 1024 MB = 1GB
Required range:
x >= 0Example:
2
name is case insensitive
unit is millicores (m). 1000m = 1 cpu
Example:
1250
unit is MB. 1024 MB = 1GB
Example:
1024
Required range:
x >= 0Example:
1
Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no container running.
Required range:
x >= 0Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit.
Show child attributes
Show child attributes
Indicates if the 'environment preview option' is enabled for this container.
If enabled, a preview environment will be automatically cloned when /preview endpoint is called.
If not specified, it takes the value of the auto_preview property from the associated environment.
Icon URI representing the container.
type of the service (application, database, job, ...)
Available options:
APPLICATION, DATABASE, CONTAINER, JOB, HELM, TERRAFORM, ARGOCD_APP Show child attributes
Show child attributes
tag of the image container
give a description to this container
optional entrypoint when launching container
Ephemeral storage of the service in GiB. When omitted, the platform default is used.
Required range:
x >= 0Example:
10
CPU architecture this service runs on. If null, the cluster default architecture is used.
Available options:
AMD64, ARM64 Show child attributes
Show child attributes
Specify if the container will be automatically updated after receiving a new image tag. The new image tag shall be communicated via the "Auto Deploy container" endpoint https://api-doc.qovery.com/#tag/Containers/operation/autoDeployContainerEnvironments
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I