Start a Job

Starts the named job from its configured start URLs. If the job was started before, applies its restart policy, then returns the initial download task IDs

Endpoint

POST /api/v3/jobs/{jobName}/start

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 string[], an array of download task IDs.

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

404 (Not Found)

Job not found

Please rotate your device to landscape mode

This documentation is specifically designed with a wider layout to provide a better reading experience for code examples, tables, and diagrams.
Rotating your device horizontally ensures you can see everything clearly without excessive scrolling or resizing.

Return to Web Data Source Home