Scaleway logo
Serverless Jobs API

A trigger is an object that specifies an automatic execution of a job definition, for example with a periodic CRON schedule


List triggers of a job definition

GET
https://api.scaleway.com
/serverless-jobs/v1alpha2/regions/{region}/triggers

List triggers of a job definition › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw

List triggers of a job definition › query Parameters

job_definition_id
​string · required

UUID of the job definition.

page
​integer · int32

Page number from paginated list of triggers.

page_size
​integer · uint32

Number of triggers per page.

Sorting order of triggers.

Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

List triggers of a job definition › Responses

200
total_count
​integer · uint64

Total count of triggers.


Create a trigger

POST
https://api.scaleway.com
/serverless-jobs/v1alpha2/regions/{region}/triggers

Create a trigger › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw

Create a trigger › Request Body

job_definition_id
​string · required

UUID of the job definition.

name
​string · pattern: ^[A-Za-z0-9-_]*$ · required

Name of the trigger.

​

Configuration of the CRON trigger. One of cron_config is required.

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: cron_config
Properties for Variant 1:
​required

Configuration of the CRON trigger. One of cron_config is required.

job_definition_id
​string

UUID of the job definition.

name
​string · pattern: ^[A-Za-z0-9-_]*$

Name of the trigger.

Create a trigger › Responses

200
id
​string

UUID of the trigger. (UUID format)

srn
​string · pattern: ^srn://jobs\.[^/]+/r…

SRN of the trigger.

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. Precisely one of cron_config can be set.

region
​string

Region in which the trigger exists.


Get a trigger

GET
https://api.scaleway.com
/serverless-jobs/v1alpha2/regions/{region}/triggers/{trigger_id}

Get a trigger › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
trigger_id
​string · required

UUID of the trigger.

Get a trigger › Responses

200
id
​string

UUID of the trigger. (UUID format)

srn
​string · pattern: ^srn://jobs\.[^/]+/r…

SRN of the trigger.

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. Precisely one of cron_config can be set.

region
​string

Region in which the trigger exists.


Update a trigger

PATCH
https://api.scaleway.com
/serverless-jobs/v1alpha2/regions/{region}/triggers/{trigger_id}

Update a trigger › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
trigger_id
​string · required

UUID of the trigger.

Update a trigger › Request Body

name
​string | null · pattern: ^[A-Za-z0-9-_]*$

Name of the trigger.

​

Configuration of the CRON trigger. Precisely one of cron_config can be set.

Update a trigger › Responses

200
id
​string

UUID of the trigger. (UUID format)

srn
​string · pattern: ^srn://jobs\.[^/]+/r…

SRN of the trigger.

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. Precisely one of cron_config can be set.

region
​string

Region in which the trigger exists.


Delete a trigger

DELETE
https://api.scaleway.com
/serverless-jobs/v1alpha2/regions/{region}/triggers/{trigger_id}

Delete a trigger › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
trigger_id
​string · required

UUID of the trigger.

Delete a trigger › Responses

No data returned