Skip to main content
PUT
/
api
/
v1
/
agent
/
{agentId}
/
schedules
/
{scheduleId}
Update an existing schedule
curl --request PUT \
  --url https://dashboard.sequentum.com/api/v1/agent/{agentId}/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "cronExpression": "<string>",
  "localSchedule": "<string>",
  "timezone": "<string>",
  "startTime": "2026-01-20T14:30:00Z",
  "inputParameters": "<string>",
  "scheduleType": 0,
  "isEnabled": true,
  "runEveryCount": 123,
  "runEveryPeriod": 123,
  "parallelism": 123,
  "parallelMaxConcurrency": 123,
  "parallelExport": "Combined",
  "proxyPoolId": 123,
  "serverGroupId": 123,
  "logLevel": "Fatal",
  "logMode": "Text",
  "isExclusive": true,
  "isWaitOnFailure": true
}
'
{
  "id": 123,
  "configId": 123,
  "name": "<string>",
  "schedule": "<string>",
  "localSchedule": "<string>",
  "timezone": "<string>",
  "nextRunTime": "2023-11-07T05:31:56Z",
  "startTime": "2023-11-07T05:31:56Z",
  "scheduleType": 0,
  "isEnabled": true,
  "runEveryCount": 123,
  "runEveryPeriod": 123,
  "inputParameters": "<string>",
  "parallelism": 123,
  "parallelMaxConcurrency": 123,
  "parallelExport": "Combined",
  "proxyPoolId": 123,
  "serverGroupId": 123,
  "logLevel": "Fatal",
  "logMode": "Text",
  "isExclusive": true,
  "isWaitOnFailure": true,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.sequentum.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API Key authorization header. Example: "Authorization: ApiKey {your-api-key}"

​
Authorization
string
header
required

OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"

Path Parameters

​
agentId
integer<int32>
required

The ID of the agent

​
scheduleId
integer<int64>
required

The ID of the schedule to update

Body

The updated schedule configuration

Request model for updating an existing schedule

​
name
string | null

Name of the schedule (required)

​
cronExpression
string | null

Cron expression for the schedule (e.g., "0 9 * * 1,4" for Mon/Thu at 9am)

​
localSchedule
string | null

Local schedule expression (human readable)

​
timezone
string | null

Timezone for the schedule (e.g., "America/New_York")

​
startTime
string<date-time> | null

Start date/time for the schedule in UTC.

  • Required for RunOnce schedules (must be at least 1 minute in the future).
  • Optional for RunEvery schedules (if provided, must be in the future; determines when the first run occurs).
  • Not used for CRON schedules.
Example:

"2026-01-20T14:30:00Z"

​
inputParameters
string | null

JSON string of input parameters for scheduled runs

​
scheduleType
enum<integer>
Available options:
0,
1,
2,
3
​
isEnabled
boolean

Whether the schedule is enabled

​
runEveryCount
integer<int32> | null

Run every N periods (used with RunEveryPeriod)

​
runEveryPeriod
integer<int32> | null

Period unit for RunEveryCount (1=minutes, 2=hours, 3=days, 4=weeks, 5=months)

​
parallelism
integer<int32> | null

Parallelism level for the scheduled run

​
parallelMaxConcurrency
integer<int32> | null

Max concurrency for parallel runs

​
parallelExport
enum<string>
Available options:
Combined,
Separated
​
proxyPoolId
integer<int32> | null

Proxy pool ID to use for scheduled runs

​
serverGroupId
integer<int32> | null

Server group ID for scheduled runs (optional). When specified, the schedule will run on servers in this group.

​
logLevel
enum<string>
Available options:
Fatal,
Error,
Warning,
Info
​
logMode
enum<string>
Available options:
Text,
TextAndHtml
​
isExclusive
boolean

Whether to run exclusively (no concurrent runs)

​
isWaitOnFailure
boolean

Whether to wait on failure before retrying

Response

Returns the updated schedule

Represents a scheduled task for an agent in the External API

​
id
integer<int64>
​
configId
integer<int32>
​
name
string | null
​
schedule
string | null
​
localSchedule
string | null
​
timezone
string | null
​
nextRunTime
string<date-time> | null
​
startTime
string<date-time> | null
​
scheduleType
enum<integer>
Available options:
0,
1,
2,
3
​
isEnabled
boolean
​
runEveryCount
integer<int32> | null
​
runEveryPeriod
integer<int32> | null
​
inputParameters
string | null
​
parallelism
integer<int32> | null
​
parallelMaxConcurrency
integer<int32> | null
​
parallelExport
enum<string>
Available options:
Combined,
Separated
​
proxyPoolId
integer<int32> | null
​
serverGroupId
integer<int32> | null
​
logLevel
enum<string>
Available options:
Fatal,
Error,
Warning,
Info
​
logMode
enum<string>
Available options:
Text,
TextAndHtml
​
isExclusive
boolean
​
isWaitOnFailure
boolean
​
created
string<date-time>
​
updated
string<date-time>