Update a job
Updates a job. Fields left out keep their value.
/project/{project_id}/environment/{environment_id}/job/{job_id}AuthorizationBearer token (JWT) · headerrequiredJWT token passed in the Authorization header using the Bearer <token> format.
project_iduuidrequiredThe unique identifier for the project
environment_iduuidrequiredThe unique identifier of the environment
job_iduuidrequiredThe unique identifier for the job
application/jsonnamestringUpdated job name.
descriptionstringUpdated job description.
typejob_typeUpdated job scheduling strategy.
cronone_timetimezonestring<timezone>Updated cron timezone.
cronstring<cron>Updated cron schedule.
configurationobjectShow propertiesHide properties
cpu_limit_in_millistringUpdated CPU limit.
ram_limit_in_mibstringUpdated RAM limit.
cpu_request_in_millistringUpdated CPU request.
ram_request_in_mibstringUpdated RAM request.
max_nb_restartintegerUpdated restart limit.
max_duration_secondsintegerUpdated max duration in seconds.
default_portintegerUpdated default probe port.
sourcecontainer_image_sourceShow propertiesHide properties
image_namestringrequiredimage name
tagstringrequiredtag of the image container
healthcheckshealthcheckConfiguration object for health check probes including readiness and liveness probe settings
Show propertiesHide properties
readiness_probeprobe | nullConfiguration for health check probes used to determine the health status of a container or service. Supports multiple probe types including TCP, HTTP, exec command, and gRPC.
Show propertiesHide properties
typeobjectShow propertiesHide properties
tcpobject | nullShow propertiesHide properties
portintegerhoststring | nullhttpobject | nullShow propertiesHide properties
pathstringschemestringportintegerexecobject | nullShow propertiesHide properties
commandstring[]grpcobject | nullShow propertiesHide properties
servicestring | nullportintegerinitial_delay_secondsintegerperiod_secondsintegertimeout_secondsintegersuccess_thresholdintegerfailure_thresholdintegerliveness_probeprobe | nullConfiguration for health check probes used to determine the health status of a container or service. Supports multiple probe types including TCP, HTTP, exec command, and gRPC.
Show propertiesHide properties
typeobjectShow propertiesHide properties
tcpobject | nullShow propertiesHide properties
portintegerhoststring | nullhttpobject | nullShow propertiesHide properties
pathstringschemestringportintegerexecobject | nullShow propertiesHide properties
commandstring[]grpcobject | nullShow propertiesHide properties
servicestring | nullportintegerinitial_delay_secondsintegerperiod_secondsintegertimeout_secondsintegersuccess_thresholdintegerfailure_thresholdintegerentrypointstringUpdated container entrypoint.
argumentsstring[]Job updated successfully
iduuidrequiredA universally unique identifier (UUID) string
organization_iduuidrequiredA universally unique identifier (UUID) string
project_iduuidrequiredA universally unique identifier (UUID) string
cluster_iduuidrequiredA universally unique identifier (UUID) string
environment_iduuidrequiredA universally unique identifier (UUID) string
namestringrequiredName of the job
descriptionstringlast_run_iduuid | nullShow propertiesHide properties
string<uuid>nulllast_run_statuscomponent_deployment_stateDeployment state for a component resource.
QUEUEDSCHEDULEDRUNNINGRETRYINGSUCCEEDEDFAILEDCANCELEDTIMED_OUTSKIPPEDNONEtypejob_typerequiredIndicates whether the job is a cron or one-time execution.
cronone_timetimezonestring<timezone>Specifies the timezone for the cron job. Defaults to UTC.
cronstring<cron>Specifies the job schedule using standard cron format (minute hour day month weekday). Does not include seconds field - follows the traditional 5-field cron syntax.
configurationobjectrequiredShow propertiesHide properties
cpu_limit_in_millistringrequiredMaximum cpu that can be allocated to the job based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu
ram_limit_in_mibstringrequiredMaximum memory that can be allocated to the job based on organization cluster configuration. unit is MB. 1024 MB = 1GB
cpu_request_in_millistringrequiredunit is millicores (m). 1000m = 1 cpu
ram_request_in_mibstringrequiredunit is MB. 1024 MB = 1GB
max_nb_restartintegerMaximum number of restart allowed before the job is considered as failed 0 means that no restart/crash of the job is allowed
max_duration_secondsintegerMaximum number of seconds allowed for the job to run before killing it and mark it as failed
default_portinteger | nullPort where to run readiness and liveliness probes checks. The port will not be exposed externally
sourcecontainer_image_sourcerequiredShow propertiesHide properties
image_namestringrequiredimage name
tagstringrequiredtag of the image container
healthcheckshealthcheckrequiredConfiguration object for health check probes including readiness and liveness probe settings
Show propertiesHide properties
readiness_probeprobe | nullConfiguration for health check probes used to determine the health status of a container or service. Supports multiple probe types including TCP, HTTP, exec command, and gRPC.
Show propertiesHide properties
typeobjectShow propertiesHide properties
tcpobject | nullShow propertiesHide properties
portintegerhoststring | nullhttpobject | nullShow propertiesHide properties
pathstringschemestringportintegerexecobject | nullShow propertiesHide properties
commandstring[]grpcobject | nullShow propertiesHide properties
servicestring | nullportintegerinitial_delay_secondsintegerperiod_secondsintegertimeout_secondsintegersuccess_thresholdintegerfailure_thresholdintegerliveness_probeprobe | nullConfiguration for health check probes used to determine the health status of a container or service. Supports multiple probe types including TCP, HTTP, exec command, and gRPC.
Show propertiesHide properties
typeobjectShow propertiesHide properties
tcpobject | nullShow propertiesHide properties
portintegerhoststring | nullhttpobject | nullShow propertiesHide properties
pathstringschemestringportintegerexecobject | nullShow propertiesHide properties
commandstring[]grpcobject | nullShow propertiesHide properties
servicestring | nullportintegerinitial_delay_secondsintegerperiod_secondsintegertimeout_secondsintegersuccess_thresholdintegerfailure_thresholdintegerentrypointstringContainer entrypoint
argumentsstring[]Error
codeinteger<int32>requiredmessagestringrequiredreasonstringOptional stable machine-readable reason for programmatic error handling