Traversal Scheduling
Upsert Traversal Schedule
Creates or replaces the named job’s TraversalSchedule for automatic runs. A saved TraversalConfig is required. This configures future runs and does not start one immediately
Requires the Traversal Scheduling feature. Scheduling is available starting with the Business plan.
Endpoint
POST /api/v3/jobs/{jobName}/traversal/schedule
Path Parameters
| Name | Type | Description |
|---|---|---|
| jobName | string | Required. Unique job name within the tenant. Reuse the same value to manage job config, start crawls, fetch URLs, inspect tasks and Traversal runs, and query indexed data |
Request Body
Required application/json body containing a TraversalSchedule.
Responses
204 (No Content)
Returns void with no response body.
400 (Bad Request)
Invalid request parameters. Refer to the response text for more information
403 (Forbidden)
Access restricted. Refer to the response text for more information
Get Traversal Schedule
Reads the named job’s saved automatic Traversal schedule. A saved TraversalConfig is required
Requires the Traversal Scheduling feature. Scheduling is available starting with the Business plan.
Endpoint
GET /api/v3/jobs/{jobName}/traversal/schedule
Path Parameters
| Name | Type | Description |
|---|---|---|
| jobName | string | Required. Unique job name within the tenant. Reuse the same value to manage job config, start crawls, fetch URLs, inspect tasks and Traversal runs, and query indexed data |
Responses
200 (Ok)
Returns TraversalSchedule? as a TraversalSchedule, or null when no schedule is saved.
400 (Bad Request)
Invalid request parameters. Refer to the response text for more information
403 (Forbidden)
Access restricted. Refer to the response text for more information
Delete Traversal Schedule
Deletes the named job’s TraversalSchedule and stops future scheduled starts. A saved TraversalConfig is required. This does not delete the job, Traversal config, or previous runs
Requires the Traversal Scheduling feature. Scheduling is available starting with the Business plan.
Endpoint
DELETE /api/v3/jobs/{jobName}/traversal/schedule
Path Parameters
| Name | Type | Description |
|---|---|---|
| jobName | string | Required. Unique job name within the tenant. Reuse the same value to manage job config, start crawls, fetch URLs, inspect tasks and Traversal runs, and query indexed data |
Responses
204 (No Content)
Returns void with no response body.
400 (Bad Request)
Invalid request parameters. Refer to the response text for more information
403 (Forbidden)
Access restricted. Refer to the response text for more information
Data Contracts
TraversalSchedule
Configures automatic Traversal runs for a job
Fields:
| Name | Type | Description |
|---|---|---|
| CronExpression | string | Five-field cron expression evaluated in UTC after the previous run completes: minute, hour, day of month, month, day of week. For example, ‘0 0 * * *’ schedules midnight UTC |
| Enabled | bool | Optional. When true, allow automatic runs according to CronExpression. False disables scheduled starts without preventing manual runs |