RCrclone
vfs

Get or set poll interval

Changed on

Reads or updates the VFS poll interval duration, optionally waiting for the change to apply.

post/vfs/poll-interval

Request

Headers

Prefer'respond-async'

Set to respond-async to run the call in the background. Rclone returns a 202 with a job ID right away, and job/status reports progress. This has the same effect as the _async param in rclone's docs, but _async alone returns a 200 instead of a 202.

Request body

_configobject

Config overrides for this call only.

_filterobject

Filter overrides for this call only.

_groupstring

Stats group for this call.

fsstring

Optional VFS identifier whose poll interval should be queried or modified.

intervalstring

Duration string (e.g. 5m) to set as the new poll interval.

timeoutstring

Duration to wait for the poll interval change to take effect; 0 waits indefinitely.

Response

Status of the poll-interval setting, possibly including the new interval.

enabledboolean required

True if polling is on.

supportedboolean required

True if the remote supports polling.

timeoutboolean

True if setting the interval timed out. Only present when setting it.

Changes

  • 9abe65975575Revision changes
    • info

      api tag vfs added

  • 1d0b982bbbffRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status