A job definition is a template that contains all the information necessary to run a job
List all your job definitions with filters
path Parameters
regionThe region you want to target
query Parameters
pagepage_sizeorder_byproject_idorganization_idList all your job definitions with filters › Responses
total_countCreate a new job definition in a specified Project
path Parameters
regionThe region you want to target
Create a new job definition in a specified Project › Request Body
nameName of the job definition.
cpu_limitCPU limit of the job (in mvCPU).
memory_limitMemory limit of the job (in MiB).
image_uriImage to use for the job.
project_idUUID of the Scaleway Project containing the job.
local_storage_capacityLocal storage capacity of the job (in MiB).
startup_commandJob startup command. Overrides the default defined in the job image. The main executable or entrypoint script to run. If both command and startup_command are provided, only startup_command will be used.
argsJob arguments. Overrides the default arguments defined in the job image. Passed to the startup command at runtime. Environment variables and secrets can be included, and will be expanded before the arguments are used.
Environment variables of the job.
descriptionDescription of the job.
job_timeoutTimeout of the job in seconds. (in seconds)
Configure a cron for the job.
commandStartup command. If empty or not defined, the image's default command is used. Deprecated: please use startup_command instead.
Create a new job definition in a specified Project › Responses
idUUID of the job definition. (UUID format)
nameName of the job definition.
project_idUUID of the Scaleway Project containing the job. (UUID format)
created_atCreation date of the job definition. (RFC 3339 format)
updated_atLast update date of the job definition. (RFC 3339 format)
cpu_limitCPU limit of the job (in mvCPU).
memory_limitMemory limit of the job (in MiB).
local_storage_capacityLocal storage capacity of the job (in MiB).
image_uriImage to use for the job.
Environment variables of the job.
job_timeoutTimeout of the job in seconds. (in seconds)
descriptionDescription of the job.
Configure a cron for the job.
startup_commandJob startup command.
argsJob arguments passed to the startup command at runtime.
Retry behaviour in case of job failure.
regionThe region you want to target
commandDeprecated, please use startup_command instead.
Get a job definition by its unique identifier
path Parameters
regionThe region you want to target
job_definition_idUUID of the job definition to get.
Get a job definition by its unique identifier › Responses
idUUID of the job definition. (UUID format)
nameName of the job definition.
project_idUUID of the Scaleway Project containing the job. (UUID format)
created_atCreation date of the job definition. (RFC 3339 format)
updated_atLast update date of the job definition. (RFC 3339 format)
cpu_limitCPU limit of the job (in mvCPU).
memory_limitMemory limit of the job (in MiB).
local_storage_capacityLocal storage capacity of the job (in MiB).
image_uriImage to use for the job.
Environment variables of the job.
job_timeoutTimeout of the job in seconds. (in seconds)
descriptionDescription of the job.
Configure a cron for the job.
startup_commandJob startup command.
argsJob arguments passed to the startup command at runtime.
Retry behaviour in case of job failure.
regionThe region you want to target
commandDeprecated, please use startup_command instead.
Update an existing job definition associated with the specified unique identifier
path Parameters
regionThe region you want to target
job_definition_idUUID of the job definition to update.
Update an existing job definition associated with the specified unique identifier › Request Body
nameName of the job definition.
cpu_limitCPU limit of the job (in mvCPU).
memory_limitMemory limit of the job (in MiB).
local_storage_capacityLocal storage capacity of the job (in MiB).
image_uriImage to use for the job.
startup_commandJob startup command. Overrides the default defined in the job image. The main executable or entrypoint script to run. If both command and startup_command are provided, only startup_command will be used.
argsJob arguments. Overrides the default arguments defined in the job image. Passed to the startup command at runtime. Environment variables and secrets can be included, and will be expanded before the arguments are used.
Environment variables of the job.
descriptionDescription of the job.
job_timeoutTimeout of the job in seconds. (in seconds)
Configure a cron for the job.
commandStartup command. If empty or not defined, the image's default command is used. Deprecated: please use startup_command instead.
Update an existing job definition associated with the specified unique identifier › Responses
idUUID of the job definition. (UUID format)
nameName of the job definition.
project_idUUID of the Scaleway Project containing the job. (UUID format)
created_atCreation date of the job definition. (RFC 3339 format)
updated_atLast update date of the job definition. (RFC 3339 format)
cpu_limitCPU limit of the job (in mvCPU).
memory_limitMemory limit of the job (in MiB).
local_storage_capacityLocal storage capacity of the job (in MiB).
image_uriImage to use for the job.
Environment variables of the job.
job_timeoutTimeout of the job in seconds. (in seconds)
descriptionDescription of the job.
Configure a cron for the job.
startup_commandJob startup command.
argsJob arguments passed to the startup command at runtime.
Retry behaviour in case of job failure.
regionThe region you want to target
commandDeprecated, please use startup_command instead.
Run an existing job definition using its unique identifier and create a new job run
path Parameters
regionThe region you want to target
job_definition_idUUID of the job definition to start.
Run an existing job definition using its unique identifier and create a new job run › Request Body
startup_commandContextual startup command for this specific job run. Overrides the default defined in the job image. The main executable or entrypoint script to run. If both command and startup_command are provided, only startup_command will be used.
argsContextual arguments for this specific job run. Overrides the default arguments defined in the job image. Passed to the contextual startup command at runtime. Environment variables and secrets can be included, and will be expanded before the arguments are used.
Contextual environment variables for this specific job run.
replicasNumber of jobs to run.
commandContextual startup command for this specific job run. If empty or not defined, the image's default command is used. Deprecated: please use startup_command instead.
Run an existing job definition using its unique identifier and create a new job run › Responses
List of started job runs.