triggers

Download schema

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.

order_by

string · enum

Sorting order of triggers.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

List triggers of a job definition › Responses

200

scaleway.serverless_jobs.v1alpha2.ListTriggersResponse

scaleway.serverless_jobs.v1alpha2.Trigger[]

List of triggers.

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 · required

Name of the trigger.

object

Configuration of the CRON trigger.

Create a trigger › Responses

200

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 · date-time

Creation time of the trigger. (RFC 3339 format)

updated_at

string · date-time

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

object

Configuration of the CRON trigger.

POST/serverless-jobs/v1alpha2/regions/{region}/triggers

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job_definition_id":"string","name":"string"}' \
  "https://api.scaleway.com/serverless-jobs/v1alpha2/regions/{region}/triggers"

Example Request Body

{
  "job_definition_id": "job_definition_id",
  "name": "name",
  "cron_config": {
    "schedule": "schedule",
    "timezone": "timezone",
    "startup_command": [
      "string"
    ],
    "args": [
      "string"
    ]
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "job_definition_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "cron_config": {
    "schedule": "schedule",
    "timezone": "timezone",
    "startup_command": [
      "string"
    ],
    "args": [
      "string"
    ]
  }
}

json

application/json

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

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 · date-time

Creation time of the trigger. (RFC 3339 format)

updated_at

string · date-time

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

object

Configuration of the CRON trigger.

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

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

Name of the trigger.

object

Configuration of the CRON trigger.

Update a trigger › Responses

200

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 · date-time

Creation time of the trigger. (RFC 3339 format)

updated_at

string · date-time

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

object

Configuration of the CRON trigger.

PATCH/serverless-jobs/v1alpha2/regions/{region}/triggers/{trigger_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/serverless-jobs/v1alpha2/regions/{region}/triggers/{trigger_id}"

Example Request Body

{
  "name": "name",
  "cron_config": {
    "schedule": "schedule",
    "timezone": "timezone",
    "startup_command": [
      "string"
    ],
    "args": [
      "string"
    ]
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "job_definition_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "cron_config": {
    "schedule": "schedule",
    "timezone": "timezone",
    "startup_command": [
      "string"
    ],
    "args": [
      "string"
    ]
  }
}

json

application/json

Secrets

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.

order_by

string · enum

Sorting order of triggers.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

List triggers of a job definition › Responses

200

scaleway.serverless_jobs.v1alpha2.ListTriggersResponse

scaleway.serverless_jobs.v1alpha2.Trigger[]

List of triggers.

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 · required

Name of the trigger.

object

Configuration of the CRON trigger.

Create a trigger › Responses

200

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 · date-time

Creation time of the trigger. (RFC 3339 format)

updated_at

string · date-time

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

object

Configuration of the CRON trigger.

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

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 · date-time

Creation time of the trigger. (RFC 3339 format)

updated_at

string · date-time

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

object

Configuration of the CRON trigger.

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

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

Name of the trigger.

object

Configuration of the CRON trigger.

Update a trigger › Responses

200

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 · date-time

Creation time of the trigger. (RFC 3339 format)

updated_at

string · date-time

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

object

Configuration of the CRON trigger.