Scheduled Tasks

Create Task

Changed on

Create a new scheduled task for a service.

post/services/{uuid}/scheduled-tasks

Request

  • Base URL: https://app.coolify.io/api/v1
  • URL: https://app.coolify.io/api/v1/services/{uuid}/scheduled-tasks
  • Auth: HTTP bearer

Path parameters

uuidstring required

UUID of the service.

Request body

namestring required

The name of the scheduled task.

commandstring required

The command to execute.

frequencystring required

The frequency of the scheduled task.

containerstring nullable

The container where the command should be executed.

timeoutinteger

The timeout of the scheduled task in seconds.

enabledboolean

The flag to indicate if the scheduled task is enabled. An enabled task requires the deploy ability.

Response

Scheduled task created.

idinteger

The unique identifier of the scheduled task in the database.

uuidstring

The unique identifier of the scheduled task.

enabledboolean

The flag to indicate if the scheduled task is enabled.

namestring

The name of the scheduled task.

commandstring

The command to execute.

frequencystring

The frequency of the scheduled task.

containerstring nullable

The container where the command should be executed.

timeoutinteger

The timeout of the scheduled task in seconds.

created_atstring date-time

The date and time when the scheduled task was created.

updated_atstring date-time

The date and time when the scheduled task was last updated.

Changes