Skip to main content
POST
/
environment
/
{environmentId}
/
job
Create a job
curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/job \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "cpu": 1250,
  "memory": 1024,
  "gpu": 1,
  "max_nb_restart": 0,
  "max_duration_seconds": 1,
  "auto_preview": true,
  "port": null,
  "source": {
    "image": {
      "image_name": "<string>",
      "tag": "<string>",
      "registry_id": "<string>"
    },
    "docker": {
      "git_repository": {
        "url": "https://github.com/Qovery/simple-node-app",
        "branch": "feat/text_xxx",
        "root_path": "/",
        "git_token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "provider": "BITBUCKET"
      },
      "dockerfile_path": "<string>",
      "dockerfile_raw": "<string>",
      "docker_target_build_stage": "<string>"
    }
  },
  "healthchecks": {
    "readiness_probe": {
      "type": {
        "tcp": {
          "port": 123,
          "host": "<string>"
        },
        "http": {
          "path": "<string>",
          "scheme": "<string>",
          "port": 123
        },
        "exec": {
          "command": [
            "<string>"
          ]
        },
        "grpc": {
          "service": "<string>",
          "port": 123
        }
      },
      "initial_delay_seconds": 123,
      "period_seconds": 123,
      "timeout_seconds": 123,
      "success_threshold": 123,
      "failure_threshold": 123
    },
    "liveness_probe": {
      "type": {
        "tcp": {
          "port": 123,
          "host": "<string>"
        },
        "http": {
          "path": "<string>",
          "scheme": "<string>",
          "port": 123
        },
        "exec": {
          "command": [
            "<string>"
          ]
        },
        "grpc": {
          "service": "<string>",
          "port": 123
        }
      },
      "initial_delay_seconds": 123,
      "period_seconds": 123,
      "timeout_seconds": 123,
      "success_threshold": 123,
      "failure_threshold": 123
    }
  },
  "schedule": {
    "on_start": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>"
    },
    "on_stop": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>"
    },
    "on_delete": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>"
    },
    "cronjob": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>",
      "timezone": "<string>",
      "scheduled_at": "<string>"
    },
    "lifecycle_type": "GENERIC"
  },
  "auto_deploy": true,
  "annotations_groups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "labels_groups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "icon_uri": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "environment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "maximum_cpu": 16000,
  "maximum_memory": 16384,
  "maximum_gpu": 2,
  "name": "<string>",
  "description": "<string>",
  "cpu": 1250,
  "memory": 1024,
  "gpu": 1,
  "max_nb_restart": 1,
  "max_duration_seconds": 1,
  "auto_preview": true,
  "port": null,
  "source": {
    "image": {
      "image_name": "<string>",
      "tag": "<string>",
      "registry_id": "<string>",
      "registry": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "url": "<string>",
        "kind": "ECR"
      }
    }
  },
  "healthchecks": {
    "readiness_probe": {
      "type": {
        "tcp": {},
        "http": {},
        "exec": {},
        "grpc": {}
      },
      "initial_delay_seconds": 123,
      "period_seconds": 123,
      "timeout_seconds": 123,
      "success_threshold": 123,
      "failure_threshold": 123
    },
    "liveness_probe": {
      "type": {
        "tcp": {},
        "http": {},
        "exec": {},
        "grpc": {}
      },
      "initial_delay_seconds": 123,
      "period_seconds": 123,
      "timeout_seconds": 123,
      "success_threshold": 123,
      "failure_threshold": 123
    }
  },
  "auto_deploy": true,
  "icon_uri": "<string>",
  "service_type": "APPLICATION",
  "job_type": "LIFECYCLE",
  "schedule": {
    "on_start": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>"
    },
    "on_stop": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>"
    },
    "on_delete": {
      "arguments": [
        "<string>"
      ],
      "entrypoint": "<string>"
    },
    "lifecycle_type": "GENERIC"
  },
  "annotations_groups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "annotations": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "scopes": [
        "DEPLOYMENTS"
      ]
    }
  ],
  "labels_groups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "labels": [
        {
          "key": "<string>",
          "value": "<string>",
          "propagate_to_cloud_provider": true
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Prefix your token with "Token ". Curl Example: curl https://console.qovery.com/organization -H "Authorization: Token $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

​
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
​
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

  • Option 2
​
job_type
enum<string>
required

type of job

Available options:
LIFECYCLE,
CRON
​
schedule
object
required
​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
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
  • Option 1
  • Option 2
​
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
​
annotations_groups
object[]
​
labels_groups
object[]
​
updated_at
string<date-time>
​
description
string
​
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