Skip to main content
PATCH

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

account_id
integer
required

ID of the account in which the source crawl is resolved.

id
integer
required

ID of a crawl in this account representing the source URL.

Body

application/json

At least one setting is required. Unknown keys are ignored by the current controller.

priority
integer
required

JSON integer crawl priority.

Required range: 0 <= x <= 3
recrawl_interval_hours
integer | null

JSON integer hours, or null to clear the cadence.

Required range: 24 <= x <= 8760

Response

Success; state and audit details are described on the published page.

Persisted source settings; cadence does not schedule paid crawls by itself.

source_url
string
required

Untrusted source URL.

priority
integer
required

Persisted crawl priority.

Required range: 0 <= x <= 3
recrawl_interval_hours
integer | null
required

Persisted cadence in hours, or null for manual crawls only.

Required range: 24 <= x <= 8760