Scaleway logo
Serverless Jobs API
Serverless Jobs API

Schemas

Download schema

scaleway.serverless_jobs.v1alpha2.CreateJobDefinitionRequest.CronScheduleConfig

schedule
​string
timezone
​string

scaleway.serverless_jobs.v1alpha2.CreateSecretsRequest.SecretConfig

secret_manager_id
​string
secret_manager_version
​string
path
​string | null · pattern: ^/[a-zA-Z0-9/_.-]*(\…
env_var_name
​string | null · pattern: [-._a-zA-Z0-9]+

scaleway.serverless_jobs.v1alpha2.CreateSecretsResponse

List of secrets created.

scaleway.serverless_jobs.v1alpha2.CreateTriggerRequest.CronConfig

schedule
​string · required

CRON schedule in UNIX format.

timezone
​string · required

Time zone for the CRON schedule.

startup_command
​string[]

Startup command that will be used by the triggered job.

args
​string[]

Arguments passed to the startup command used by the triggered job.

scaleway.serverless_jobs.v1alpha2.CronSchedule

schedule
​string · required

UNIX cron schedule to run job (e.g., '* * * * *').

timezone
​string · required

Timezone for the cron schedule, in tz database format (e.g., 'Europe/Paris').

scaleway.serverless_jobs.v1alpha2.JobDefinition

id
​string

UUID of the job definition. (UUID format)

name
​string

Name of the job definition.

project_id
​string

UUID of the Scaleway Project containing the job. (UUID format)

created_at
​string | null · date-time

Creation date of the job definition. (RFC 3339 format)

updated_at
​string | null · date-time

Last update date of the job definition. (RFC 3339 format)

cpu_limit
​integer · uint32

CPU limit of the job (in mvCPU).

memory_limit
​integer · uint32

Memory limit of the job (in MiB).

local_storage_capacity
​integer · uint32

Local storage capacity of the job (in MiB).

image_uri
​string

Image to use for the job.

​object

Environment variables of the job.

job_timeout
​string | null

Timeout of the job in seconds. (in seconds)

description
​string

Description of the job.

Configure a cron for the job.

startup_command
​string[]

Job startup command.

args
​string[]

Job arguments passed to the startup command at runtime.

Retry behaviour in case of job failure.

region
​string

The region you want to target

scaleway.serverless_jobs.v1alpha2.JobRun

id
​string

UUID of the job run. (UUID format)

job_definition_id
​string

UUID of the job definition. (UUID format)

created_at
​string | null · date-time

Creation date of the job run. (RFC 3339 format)

updated_at
​string | null · date-time

Last update date of the job run. (RFC 3339 format)

started_at
​string | null · date-time

Start date of the job run. (RFC 3339 format)

terminated_at
​string | null · date-time

Termination date of the job run. (RFC 3339 format)

run_duration
​string | null

Duration of the job run. (in seconds)

State of the job run.

Enum values:
unknown_state
initialized
validated
queued
running
succeeded
failed
interrupting
Default: unknown_state

Reason for failure if the job failed.

Enum values:
unknown_reason
invalid_request
timeout
cancellation
technical_error
image_not_found
invalid_image
memory_usage_exceeded
Default: unknown_reason
exit_code
​integer | null · int32

Exit code of the job.

error_message
​string | null

Error message if the job failed.

cpu_limit
​integer · uint32

CPU limit of the job (in mvCPU).

memory_limit
​integer · uint32

Memory limit of the job (in MiB).

local_storage_capacity
​integer · uint32

Local storage capacity of the job (in MiB).

​object

Environment variables of the job run.

startup_command
​string[]

Job startup command.

args
​string[]

Job arguments passed to the startup command at runtime.

attempts
​integer | null · uint32

Number of run attempts.

region
​string

The region you want to target

scaleway.serverless_jobs.v1alpha2.JobRun.Reason

string · enum
Enum values:
unknown_reason
invalid_request
timeout
cancellation
technical_error
image_not_found
invalid_image
memory_usage_exceeded
Default: unknown_reason

scaleway.serverless_jobs.v1alpha2.JobRun.State

string · enum
Enum values:
unknown_state
initialized
validated
queued
running
succeeded
failed
interrupting
Default: unknown_state

scaleway.serverless_jobs.v1alpha2.ListJobDefinitionsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

scaleway.serverless_jobs.v1alpha2.ListJobDefinitionsResponse

total_count
​integer · uint64

scaleway.serverless_jobs.v1alpha2.ListJobRunsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

scaleway.serverless_jobs.v1alpha2.ListJobRunsResponse

total_count
​integer · uint64

scaleway.serverless_jobs.v1alpha2.ListSecretsResponse

List of secret references within a job definition.

total_count
​integer · uint64

Total count of secret references within a job definition.

scaleway.serverless_jobs.v1alpha2.ListTriggersRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

scaleway.serverless_jobs.v1alpha2.ListTriggersResponse

List of triggers.

total_count
​integer · uint64

Total count of triggers.

scaleway.serverless_jobs.v1alpha2.RetryPolicy

max_retries
​integer · uint32 · required

Maximum number of retries upon a job failure.

scaleway.serverless_jobs.v1alpha2.Secret

job_definition_id
​string · required

UUID of the job definition. (UUID format)

secret_id
​string

UUID of the secret reference within the job. (UUID format)

secret_manager_id
​string

UUID of the secret in Secret Manager. (UUID format)

secret_manager_version
​string

Version of the secret in Secret Manager.

​

File secret mounted inside the job.

​

Environment variable used to expose the secret.

scaleway.serverless_jobs.v1alpha2.Secret.EnvVar

name
​string

scaleway.serverless_jobs.v1alpha2.Secret.File

path
​string

scaleway.serverless_jobs.v1alpha2.StartJobDefinitionResponse

List of started job runs.

scaleway.serverless_jobs.v1alpha2.Trigger

id
​string

UUID of the trigger. (UUID format)

job_definition_id
​string

UUID of the job definition. (UUID format)

name
​string

Human readable name of the trigger.

created_at
​string | null · date-time

Creation time of the trigger. (RFC 3339 format)

updated_at
​string | null · date-time

Last update time of the trigger. (RFC 3339 format)

​

Configuration of the CRON trigger.

scaleway.serverless_jobs.v1alpha2.Trigger.CronConfig

schedule
​string

CRON schedule in UNIX format.

timezone
​string

Time zone for the CRON schedule.

startup_command
​string[]

Startup command that will be used by the triggered job.

args
​string[]

Arguments passed to the startup command used by the triggered job.

scaleway.serverless_jobs.v1alpha2.UpdateJobDefinitionRequest.CronScheduleConfig

schedule
​string | null
timezone
​string | null

scaleway.serverless_jobs.v1alpha2.UpdateJobDefinitionRequest.UpdateRetryPolicy

max_retries
​integer | null · uint32

scaleway.serverless_jobs.v1alpha2.UpdateTriggerRequest.CronConfig

schedule
​string | null

CRON schedule in UNIX format.

timezone
​string | null

Time zone for the CRON schedule.

startup_command
​array | null

Startup command that will be used by the triggered job.

args
​array | null

Arguments passed to the startup command used by the triggered job.