Skip to content

Edit a schedule

PATCH
/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule}

Authorizations

Parameters

Path Parameters

organization
required
string

Organization identifier

project
required
string

Project identifier

crawler
required
string

Crawler identifier

crawler_schedule
required
string

Crawler schedule identifier

Request Body required

object
name

Schedule name. If not provided, defaults to ‘Schedule {crawler_name}’.

string
Daily Crawl
schedule_cron_string
required

Standard Unix cron expression with 5 space-separated fields: minute, hour, day-of-month, month, day-of-week. Example: 0 2 * * * for daily at 2 AM.

string
0 2 * * *

Responses

200

The crawler schedule.

object
id
required

Schedule ID

integer
1
name

Schedule name

string
Test schedule
crawler_config_id
required

Crawler config ID

integer
456
crawler_uuid

Crawler UUID

string
550e8400-e29b-41d4-a716-446655440000
project_id
required

Project ID

integer
789
crawler_last_run_id
required

Last run ID

integer
12345
schedule_cron_string
required

Standard Unix cron expression with 5 space-separated fields: minute, hour, day-of-month, month, day-of-week. Example: 0 2 * * * runs daily at 2 AM.

string
0 2 * * *
created_at

Creation timestamp

string format: date-time
2024-01-20T09:15:00Z
updated_at

Last update timestamp

string format: date-time
2024-10-11T16:45:00Z

400

The server could not understand the request due to invalid syntax.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true
{
"message": "The requested resource was not found",
"error": true
}

403

Access is forbidden.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true
{
"message": "The requested resource was not found",
"error": true
}