Pause a task's cron schedule

POST

/api/tasks/{taskName}/pause

const url = 'http://localhost:9477/api/tasks/example/pause';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:9477/api/tasks/example/pause

Skips the task’s cron ticks until it is resumed. Skipped ticks record no runs and are not caught up on resume; manual runs keep working. The pause survives reloads and daemon restarts, and a reload that removes the task’s cron, turns it into a service, or sets manual_trigger = false clears it. Pausing a paused task is a no-op that keeps the original pausedAt. 403 when manual_trigger = false; 409 for a service, a task without cron, a task a system cron daemon still holds, or a daemon whose scheduling the station owns.

Parameters

Path Parameters

taskName

required

Task name

string

>= 1 characters <= 100 characters /^[a-zA-Z0-9._:-]+$/

Task name

Responses

204

No Content

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "http://localhost:9477/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}