Jobs

Create a job

post/environment/{environmentId}/job

Request

Path parameters

environmentIdstring uuid required

Environment ID

Request body

namestring required

name is case insensitive

descriptionstring
cpuinteger

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

memoryinteger

unit is MB. 1024 MB = 1GB

gpuinteger
max_nb_restartinteger

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

max_duration_secondsinteger

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

auto_previewboolean

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.

portinteger nullable

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

auto_deployboolean nullable

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

icon_uristring uri

Icon URI representing the job.

Example request

{
  "cpu": 1250,
  "memory": 1024,
  "gpu": 1,
  "source": {
    "docker": {
      "git_repository": {
        "url": "https://github.com/Qovery/simple-node-app",
        "branch": "feat/text_xxx"
      }
    }
  }
}

Response

Create job

OR

Example response

{
  "maximum_cpu": 16000,
  "maximum_memory": 16384,
  "maximum_gpu": 2,
  "cpu": 1250,
  "memory": 1024,
  "gpu": 1,
  "source": {
    "docker": {
      "git_repository": {
        "owner": "John Doe",
        "name": "simple-node-app",
        "deployed_commit_tag": "v1.0.1"
      }
    }
  }
}

Changes

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