Skip to main content
POST
/
environment
/
{environmentId}
/
job
Create a job
curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<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
    }
  },
  "description": "<string>",
  "cpu": 1250,
  "memory": 1024,
  "gpu": 1,
  "ephemeral_storage_in_gib": 10,
  "max_nb_restart": 0,
  "max_duration_seconds": 1,
  "auto_preview": true,
  "port": null,
  "source": {
    "image": {
      "image_name": "<string>",
      "tag": "<string>",
      "registry_id": "<string>"
    },
    "docker": {
      "dockerfile_path": "<string>",
      "dockerfile_raw": "<string>",
      "docker_target_build_stage": "<string>"
    }
  },
  "schedule": {
    "on_start": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>"
    },
    "on_stop": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>"
    },
    "on_delete": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>"
    }
  },
  "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}/job"

payload = {
    "name": "<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
        }
    },
    "description": "<string>",
    "cpu": 1250,
    "memory": 1024,
    "gpu": 1,
    "ephemeral_storage_in_gib": 10,
    "max_nb_restart": 0,
    "max_duration_seconds": 1,
    "auto_preview": True,
    "port": None,
    "source": {
        "image": {
            "image_name": "<string>",
            "tag": "<string>",
            "registry_id": "<string>"
        },
        "docker": {
            "dockerfile_path": "<string>",
            "dockerfile_raw": "<string>",
            "docker_target_build_stage": "<string>"
        }
    },
    "schedule": {
        "on_start": {
            "arguments": ["<string>"],
            "entrypoint": "<string>"
        },
        "on_stop": {
            "arguments": ["<string>"],
            "entrypoint": "<string>"
        },
        "on_delete": {
            "arguments": ["<string>"],
            "entrypoint": "<string>"
        }
    },
    "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>',
    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
      }
    },
    description: '<string>',
    cpu: 1250,
    memory: 1024,
    gpu: 1,
    ephemeral_storage_in_gib: 10,
    max_nb_restart: 0,
    max_duration_seconds: 1,
    auto_preview: true,
    port: null,
    source: {
      image: {image_name: '<string>', tag: '<string>', registry_id: '<string>'},
      docker: {
        dockerfile_path: '<string>',
        dockerfile_raw: '<string>',
        docker_target_build_stage: '<string>'
      }
    },
    schedule: {
      on_start: {arguments: ['<string>'], entrypoint: '<string>'},
      on_stop: {arguments: ['<string>'], entrypoint: '<string>'},
      on_delete: {arguments: ['<string>'], entrypoint: '<string>'}
    },
    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}/job', 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}/job",
  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>',
    '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
        ]
    ],
    'description' => '<string>',
    'cpu' => 1250,
    'memory' => 1024,
    'gpu' => 1,
    'ephemeral_storage_in_gib' => 10,
    'max_nb_restart' => 0,
    'max_duration_seconds' => 1,
    'auto_preview' => true,
    'port' => null,
    'source' => [
        'image' => [
                'image_name' => '<string>',
                'tag' => '<string>',
                'registry_id' => '<string>'
        ],
        'docker' => [
                'dockerfile_path' => '<string>',
                'dockerfile_raw' => '<string>',
                'docker_target_build_stage' => '<string>'
        ]
    ],
    'schedule' => [
        'on_start' => [
                'arguments' => [
                                '<string>'
                ],
                'entrypoint' => '<string>'
        ],
        'on_stop' => [
                'arguments' => [
                                '<string>'
                ],
                'entrypoint' => '<string>'
        ],
        'on_delete' => [
                'arguments' => [
                                '<string>'
                ],
                'entrypoint' => '<string>'
        ]
    ],
    '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}/job"

	payload := strings.NewReader("{\n  \"name\": \"<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  \"description\": \"<string>\",\n  \"cpu\": 1250,\n  \"memory\": 1024,\n  \"gpu\": 1,\n  \"ephemeral_storage_in_gib\": 10,\n  \"max_nb_restart\": 0,\n  \"max_duration_seconds\": 1,\n  \"auto_preview\": true,\n  \"port\": null,\n  \"source\": {\n    \"image\": {\n      \"image_name\": \"<string>\",\n      \"tag\": \"<string>\",\n      \"registry_id\": \"<string>\"\n    },\n    \"docker\": {\n      \"dockerfile_path\": \"<string>\",\n      \"dockerfile_raw\": \"<string>\",\n      \"docker_target_build_stage\": \"<string>\"\n    }\n  },\n  \"schedule\": {\n    \"on_start\": {\n      \"arguments\": [\n        \"<string>\"\n      ],\n      \"entrypoint\": \"<string>\"\n    },\n    \"on_stop\": {\n      \"arguments\": [\n        \"<string>\"\n      ],\n      \"entrypoint\": \"<string>\"\n    },\n    \"on_delete\": {\n      \"arguments\": [\n        \"<string>\"\n      ],\n      \"entrypoint\": \"<string>\"\n    }\n  },\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}/job")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<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  \"description\": \"<string>\",\n  \"cpu\": 1250,\n  \"memory\": 1024,\n  \"gpu\": 1,\n  \"ephemeral_storage_in_gib\": 10,\n  \"max_nb_restart\": 0,\n  \"max_duration_seconds\": 1,\n  \"auto_preview\": true,\n  \"port\": null,\n  \"source\": {\n    \"image\": {\n      \"image_name\": \"<string>\",\n      \"tag\": \"<string>\",\n      \"registry_id\": \"<string>\"\n    },\n    \"docker\": {\n      \"dockerfile_path\": \"<string>\",\n      \"dockerfile_raw\": \"<string>\",\n      \"docker_target_build_stage\": \"<string>\"\n    }\n  },\n  \"schedule\": {\n    \"on_start\": {\n      \"arguments\": [\n        \"<string>\"\n      ],\n      \"entrypoint\": \"<string>\"\n    },\n    \"on_stop\": {\n      \"arguments\": [\n        \"<string>\"\n      ],\n      \"entrypoint\": \"<string>\"\n    },\n    \"on_delete\": {\n      \"arguments\": [\n        \"<string>\"\n      ],\n      \"entrypoint\": \"<string>\"\n    }\n  },\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}/job")

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  \"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  \"description\": \"<string>\",\n  \"cpu\": 1250,\n  \"memory\": 1024,\n  \"gpu\": 1,\n  \"ephemeral_storage_in_gib\": 10,\n  \"max_nb_restart\": 0,\n  \"max_duration_seconds\": 1,\n  \"auto_preview\": true,\n  \"port\": null,\n  \"source\": {\n    \"image\": {\n      \"image_name\": \"<string>\",\n      \"tag\": \"<string>\",\n      \"registry_id\": \"<string>\"\n    },\n    \"docker\": {\n      \"dockerfile_path\": \"<string>\",\n      \"dockerfile_raw\": \"<string>\",\n      \"docker_target_build_stage\": \"<string>\"\n    }\n  },\n  \"schedule\": {\n    \"on_start\": {\n      \"arguments\": [\n        \"<string>\"\n      ],\n      \"entrypoint\": \"<string>\"\n    },\n    \"on_stop\": {\n      \"arguments\": [\n        \"<string>\"\n      ],\n      \"entrypoint\": \"<string>\"\n    },\n    \"on_delete\": {\n      \"arguments\": [\n        \"<string>\"\n      ],\n      \"entrypoint\": \"<string>\"\n    }\n  },\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",
  "environment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "maximum_cpu": 16000,
  "maximum_memory": 16384,
  "maximum_gpu": 2,
  "name": "<string>",
  "cpu": 1250,
  "memory": 1024,
  "gpu": 1,
  "auto_preview": true,
  "source": {
    "image": {
      "image_name": "<string>",
      "tag": "<string>",
      "registry": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "url": "<string>"
      },
      "registry_id": "<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
    }
  },
  "icon_uri": "<string>",
  "schedule": {
    "on_start": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>"
    },
    "on_stop": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>"
    },
    "on_delete": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>"
    }
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "ephemeral_storage_in_gib": 10,
  "max_nb_restart": 1,
  "max_duration_seconds": 1,
  "port": null,
  "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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

​
environmentId
string<uuid>
required

Environment ID

Body

application/json
​
name
string
required

name is case insensitive

​
healthchecks
object
required
​
description
string
​
cpu
integer
default:500

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

Example:

1250

​
memory
integer
default:512

unit is MB. 1024 MB = 1GB

Example:

1024

​
gpu
integer
default:0
Required range: x >= 0
Example:

1

​
ephemeral_storage_in_gib
integer

Ephemeral storage of the service in GiB. When omitted, the platform default is used.

Required range: x >= 0
Example:

10

​
max_nb_restart
integer
default:0

Maximum number of restart allowed before the job is considered as failed 0 means that no restart/crash of the job is allowed

Required range: x >= 0
​
max_duration_seconds
integer

Maximum number of seconds allowed for the job to run before killing it and mark it as failed

Required range: x >= 0
​
auto_preview
boolean

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.

​
port
integer | null

Port where to run readiness and liveliness probes checks. The port will not be exposed externally

Required range: x >= 1
​
source
object
​
cpu_architecture
enum<string> | null

CPU architecture to run this service on. If null, the cluster default architecture is used.

Available options:
AMD64,
ARM64
​
schedule
object

If you want to define a Cron job, only the cronjob property must be filled
A Lifecycle job should contain at least one property on_XXX among the 3 properties: on_start, on_stop, on_delete

​
auto_deploy
boolean | null

Specify if the job will be automatically updated after receiving a new image tag or a new commit according to the source type. The new image tag shall be communicated via the "Auto Deploy job" endpoint https://api-doc.qovery.com/#tag/Jobs/operation/autoDeployJobEnvironments

​
annotations_groups
object[]
​
labels_groups
object[]
​
icon_uri
string<uri>

Icon URI representing the job.

Response

Create job

​
id
string<uuid>
required
read-only
​
created_at
string<date-time>
required
read-only
​
environment
object
required
​
maximum_cpu
integer
required

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

Example:

16000

​
maximum_memory
integer
required

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

Example:

16384

​
maximum_gpu
integer
default:0
required

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

Required range: x >= 0
Example:

2

​
name
string
required

name is case insensitive

​
cpu
integer
required

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

Example:

1250

​
memory
integer
required

unit is MB. 1024 MB = 1GB

Example:

1024

​
gpu
integer
default:0
required
Required range: x >= 0
Example:

1

​
auto_preview
boolean
required

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.

​
source
object
required
​
healthchecks
object
required
​
icon_uri
string<uri>
required

Icon URI representing the job.

​
service_type
enum<string>
required

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

Available options:
APPLICATION,
DATABASE,
CONTAINER,
JOB,
HELM,
TERRAFORM,
ARGOCD_APP
​
job_type
enum<string>
required

type of job

Available options:
LIFECYCLE,
CRON
​
schedule
object
required
​
updated_at
string<date-time>
read-only
​
description
string
​
ephemeral_storage_in_gib
integer

Ephemeral storage of the service in GiB. When omitted, the platform default is used.

Required range: x >= 0
Example:

10

​
cpu_architecture
enum<string> | null

CPU architecture this service runs on. If null, the cluster default architecture is used.

Available options:
AMD64,
ARM64
​
max_nb_restart
integer

Maximum number of restart allowed before the job is considered as failed 0 means that no restart/crash of the job is allowed

Required range: x >= 0
​
max_duration_seconds
integer

Maximum number of seconds allowed for the job to run before killing it and mark it as failed

Required range: x >= 0
​
port
integer | null

Port where to run readiness and liveliness probes checks. The port will not be exposed externally

Required range: x >= 1
​
auto_deploy
boolean

Specify if the job will be automatically updated after receiving a new image tag or a new commit according to the source type. The new image tag shall be communicated via the "Auto Deploy job" endpoint https://api-doc.qovery.com/#tag/Jobs/operation/autoDeployJobEnvironments

​
annotations_groups
object[]
​
labels_groups
object[]