Get Traversal Schedule
Reads the named job’s saved automatic Traversal schedule. A saved TraversalConfig is required
Requires the Dapi 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
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 |