Scheduled Tasks

Update a scheduled task

Changed on
put/api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}

Request

  • Base URL: https://your-tenant.cubecloud.dev
  • URL: https://your-tenant.cubecloud.dev/api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}
  • Auth: HTTP bearer

Path parameters

deploymentIdinteger required
taskIdinteger required

Request body

agentIdinteger nullable

The agent that runs the task. Omit to leave unchanged; null resets it to the deployment default.

cronExpressionstring nullable

New standard 5-field cron, at most hourly (the minute field is a single number). Omit it to keep the current schedule; send null to make the task Manual.

descriptionstring nullable

Omit to leave unchanged. Send null to clear the description.

isEnabledboolean nullable

false pauses the schedule, true resumes it. Omit to leave unchanged. Explicit null answers 400.

namestring nullable

Omit to leave unchanged. Explicit null answers 400.

notificationEnabledboolean nullable

Turn the inbox notification for finished runs on or off. Omit to leave unchanged. Explicit null answers 400.

promptstring nullable

New prompt, shown as the task's Instructions in Cube. Omit to leave unchanged. Explicit null answers 400.

timezonestring nullable

New IANA time zone for the cron, e.g. America/New_York. Omit it to keep the current one. Explicit null answers 400.

Response

agentIdinteger nullable

The agent that runs the task; null runs the deployment default.

cronExpressionstring nullable

Standard 5-field cron (minute hour day-of-month month day-of-week), e.g. 0 9 * * 1-5 for 9:00 on weekdays. Null when the task is Manual: it runs only when started with POST /scheduled-tasks/{taskId}/run.

deploymentIdinteger required
descriptionstring nullable
idinteger required
isEnabledboolean required

False while the schedule is paused.

namestring required
nextRunAtstring nullable

When the schedule next fires (ISO 8601, UTC); null for a Manual or paused task.

notificationEnabledboolean required

Whether a finished run notifies the creator in Cube's notification inbox.

promptstring required

What the agent is asked on every run, shown as the task's Instructions in Cube. Each run starts a new chat thread, so the prompt has to stand on its own.

timezonestring required

IANA time zone the cron is read in, e.g. America/New_York. Defaults to UTC.

userIdinteger required

The creator. Every run executes as this user, and only they or an admin may change, delete or run the task.

Changes

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the new optional request property

    • info

      added the required property to the response with the status