Serverless Jobs API

v1alpha1

Introduction

Serverless Jobs is a fully managed solution that enables you to plan, schedule, and run batch processing workloads without needing to provision or scale any infrastructure. Each job is run from a job definition, which includes the image used to run the job, as well as its resources.

Concepts

Refer to our dedicated concepts page to find definitions of all terminology related to Scaleway Serverless Jobs.

Quickstart

Note

For jobs concepts and advanced documentation, please refer to Scaleway Quickstart for Jobs.

Technical information

Regions

Serverless Jobs is available in the Paris, Amsterdam and Warsaw regions, which are represented by the following path parameters:

fr-par
nl-ams
pl-waw

Going further

For more information on Scaleway Serverless Jobs, check out the following resources:

Our main documentation
The #serverless-jobs channel on our Slack Community
Our support ticketing system.

Job definitions

A Job definition is a template for a Serverless Job. It contains all the information necessary to run the job, including the container image used, the resources allocated, and the command to execute. The definition acts as a blueprint for job runs

GET/serverless-jobs/v1alpha1/regions/{region}/job-definitions

POST/serverless-jobs/v1alpha1/regions/{region}/job-definitions

GET/serverless-jobs/v1alpha1/regions/{region}/job-definitions/{job_definition_id}

PATCH/serverless-jobs/v1alpha1/regions/{region}/job-definitions/{job_definition_id}

DELETE/serverless-jobs/v1alpha1/regions/{region}/job-definitions/{job_definition_id}

POST/serverless-jobs/v1alpha1/regions/{region}/job-definitions/{job_definition_id}/start

Job runs

A job run is the execution of a job definition. It can be in a running, succeeded, canceled, or failed status. Each job run has a unique identifier and can be individually monitored using Cockpit

GET/serverless-jobs/v1alpha1/regions/{region}/job-runs

GET/serverless-jobs/v1alpha1/regions/{region}/job-runs/{job_run_id}

POST/serverless-jobs/v1alpha1/regions/{region}/job-runs/{job_run_id}/stop

Secrets

A secret reference is a logical reference to a secret stored in Scaleway Secret Manager, and it can only be managed within the context of a job definition.

GET/serverless-jobs/v1alpha1/regions/{region}/job-definitions/{job_definition_id}/secrets

POST/serverless-jobs/v1alpha1/regions/{region}/job-definitions/{job_definition_id}/secrets

GET/serverless-jobs/v1alpha1/regions/{region}/job-definitions/{job_definition_id}/secrets/{secret_id}

PATCH/serverless-jobs/v1alpha1/regions/{region}/job-definitions/{job_definition_id}/secrets/{secret_id}

DELETE/serverless-jobs/v1alpha1/regions/{region}/job-definitions/{job_definition_id}/secrets/{secret_id}