Skip to main content
POST
/
schedules
/
{scheduled_run_uid}
/
{action}
Update the status of a scheduled run
curl --request POST \
  --url https://api.edges.run/v1/schedules/{scheduled_run_uid}/{action} \
  --header 'X-API-Key: <api-key>'
{
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "action_id": 123,
  "action_name": "<string>",
  "user_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "postponed_until": "2023-11-07T05:31:56Z",
  "cron": "<string>",
  "timezone": "<string>",
  "next_execution_at": "2023-11-07T05:31:56Z",
  "last_executed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "parameters": {
    "sync_mode": "full"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.edges.run/llms.txt

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

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
scheduled_run_uid
string<uuid>
required

Scheduled run UUID

​
action
enum<string>
required

With this action, you can resume, cancel or pause the scheduled run.

Available options:
resume,
cancel,
pause

Response

Returns the scheduled runs

Returns the scheduled runs

​
uid
string<uuid>

Scheduled Run UUID

​
name
string | null

Optional user-defined label for the scheduled run.

Maximum string length: 255
​
action_id
integer

Action ID

​
action_name
string

Action name

​
user_uid
string<uuid>

Member/User UUID

​
workspace_uid
string<uuid>

Workspace UUID

​
status
enum<string> | null

Scheduled run status

Available options:
ACTIVE,
CANCELLED,
PAUSED,
COMPLETED
​
postponed_until
string<date-time> | null

If the run is postponed, this field indicates when it will be retried.

​
cron
string | null

Cron expression for the scheduled run (POSIX format)

​
timezone
string | null

Timezone for the scheduled run (IANA timezone format)

​
next_execution_at
string<date-time> | null

Next execution at

​
last_executed_at
string<date-time> | null

Last executed at

​
created_at
string<date-time> | null

Created at

​
updated_at
string<date-time> | null

Updated at

​
parameters
object