REresilio
File query

Create file query

Creates file query. Returns file query details. See get file query for the response details.

post/filequery

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Request body

job_run_idnumber required

Job run id. Files can be queried on active job runs only except for script jobs.

agents_idsnumber required

Job run Agents ids. Start file query of specified Agents. Will query files on all Job run Agents in case array is empty

typestring required

File query type

filesnumber required

Number of files to show in result. Required for type "by_file_path" and "by_statuses". Minimum value is 1. Maximum value is 1000.

file_pathstring

Show files by specified path. Required for type "by_file_path"

file_regexstring

Filter files by specified regex. For type "by_statuses"

periodnumber

Show deleted files for last N hours. Default value is 24. For type "by_statuses" and "file_status_settings.deleted"

file_status_settingsobject

Show files with specified statuses. Requried for type "by_statuses"

file_status_settings.cant_sync_nowboolean required

Show files that cannot be synced now.

file_status_settings.deletedboolean required

Show deleted files (see "period" parameter).

file_status_settings.downloadedboolean required

Show downloaded files

file_status_settings.in_queueboolean required

Show files in download queue

Response

Successful response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.