REresilio
Jobs

Update job

Update job. Any job param listed below can be updated. To delete trigger pass null instead of the object

put/jobs/{id}

Request

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

Path parameters

idnumber required

Job id

Request body

namestring required

Job name

typestring required

Job type

descriptionstring required

Job description

groupsobject required

Array of job groups

groups.idnumber required

Group id

groups.permissionstring required

Group permissions. Selective permissions (sro and srw) are allowed only for sync, file_caching and hybrid_work jobs

groups.pathobject required

Group path

groups.path.macrostring

Macro. If the parameter is not specified, custom path is used. If use %USERDEFINED% or %GETFILES% macro, you mustn't use path field for all OS Not allowed for High Availability Groups

groups.path.linuxstring required

Linux path

groups.path.linux_cachestring required

Linux cache path. Only for group with caching_gateway role

groups.path.winstring required

Windows path

groups.path.osxstring required

OS X path

groups.path.androidstring required

Android path

groups.path.xboxstring required

Xbox path. Only for distribution jobs

groups.rolestring

Role. regular by default. Required for file_caching and hybrid_work jobs. primary_storage, caching_gateway roles are used in file_caching jobs. primary_storage, caching_gateway, enduser roles are used in hybrid_work jobs. regular role is used in distribution, consolidation, script, sync, storage_tiering_and_archival jobs.

groups.file_policy_idnumber

File policy id. Required for group with caching_gateway, enduser role

groups.priority_agentsboolean

Priority agents. Only for group with primary_storage role or group in sync job.

groups.lock_serverboolean required

Locks server. Only for the case when setting.use_file_locking is true for High availability group with primary_storage role or in sync job.

agentsobject required

Array of job agents

agents.idnumber required

Agent id

agents.permissionstring required

Agent permissions. Selective permissions (sro and srw) are allowed only for sync, file_caching and hybrid_work jobs

agents.pathobject required

Agent path

agents.path.macrostring

Macro. If the parameter is not specified, custom path is used. If use %USERDEFINED% or %GETFILES% macro, you mustn't use path field for all OS

agents.path.linuxstring required

Linux path

agents.path.linux_cachestring required

Linux cache path. Only for agent with caching_gateway role

agents.path.winstring required

Windows path

agents.path.osxstring required

OS X path

agents.path.androidstring required

Android path

agents.path.xboxstring required

Xbox path. Only for distribution jobs

agents.storage_config_idnumber required

Storage connector config id If the parameter is not specified, Storage connector isn't used

agents.rolestring

Role. regular by default. Required for file_caching and hybrid_work jobs. primary_storage, caching_gateway roles are used in file_caching jobs. primary_storage, caching_gateway, enduser roles are used in hybrid_work jobs. regular role is used in distribution, consolidation, script, sync, storage_tiering_and_archival jobs.

agents.file_policy_idnumber

File policy id. Required for agent with caching_gateway, enduser role

agents.priority_agentsboolean

Priority agents. Only for agent with primary_storage role or agent in sync job.

agents.lock_serverboolean

Locks server. Only for the case when setting.use_file_locking is true for High availability group with primary_storage role or in sync job.

triggersobject

Job triggers. Only for distribution, consolidation, storage_tiering_and_archival jobs

triggers.pre_indexingobject

Before file-indexing begins

triggers.pre_indexing.linuxobject required

Linux command

triggers.pre_indexing.linux.scriptstring required

Command

triggers.pre_indexing.linux.shellstring

Shell, default "/bin/sh"

triggers.pre_indexing.linux.extstring

Script file extension, default "sh"

triggers.pre_indexing.winobject required

Windows command

triggers.pre_indexing.win.scriptstring required

Command

triggers.pre_indexing.win.shellstring

Shell, default "cmd.exe /Q /C", use "powershell -NoProfile -ExecutionPolicy Bypass -NonInteractive -InputFormat None -File" for PowerShell

triggers.pre_indexing.win.extstring

Script file extension, default "cmd", use "ps1" for PowerShell

triggers.pre_indexing.osxobject required

Mac command

triggers.pre_indexing.osx.scriptstring required

Command

triggers.pre_indexing.osx.shellstring

Shell, default "/bin/sh"

triggers.pre_indexing.osx.extstring

Script file extension, default "sh"

triggers.pre_indexing.androidobject required

Android command

triggers.pre_indexing.android.scriptstring required

Command

triggers.pre_indexing.android.shellstring

Shell, default "/system/bin/sh"

triggers.pre_indexing.android.extstring

Script file extension, default "sh"

triggers.pre_moveobject

Before an agent finalizing download. Only for distribution jobs

triggers.pre_move.linuxobject required

Linux command

triggers.pre_move.linux.scriptstring required

Command

triggers.pre_move.linux.shellstring

Shell, default "/bin/sh"

triggers.pre_move.linux.extstring

Script file extension, default "sh"

triggers.pre_move.winobject required

Windows command

triggers.pre_move.win.scriptstring required

Command

triggers.pre_move.win.shellstring

Shell, default "cmd.exe /Q /C", use "powershell -NoProfile -ExecutionPolicy Bypass -NonInteractive -InputFormat None -File" for PowerShell

triggers.pre_move.win.extstring

Script file extension, default "cmd", use "ps1" for PowerShell

triggers.pre_move.osxobject required

Mac command

triggers.pre_move.osx.scriptstring required

Command

triggers.pre_move.osx.shellstring

Shell, default "/bin/sh"

triggers.pre_move.osx.extstring

Script file extension, default "sh"

triggers.pre_move.androidobject required

Android command

triggers.pre_move.android.scriptstring required

Command

triggers.pre_move.android.shellstring

Shell, default "/system/bin/sh"

triggers.pre_move.android.extstring

Script file extension, default "sh"

triggers.post_downloadobject

After an agent completes downloading

triggers.post_download.linuxobject required

Linux command

triggers.post_download.linux.scriptstring required

Command

triggers.post_download.linux.shellstring

Shell, default "/bin/sh"

triggers.post_download.linux.extstring

Script file extension, default "sh"

triggers.post_download.winobject required

Windows command

triggers.post_download.win.scriptstring required

Command

triggers.post_download.win.shellstring

Shell, default "cmd.exe /Q /C", use "powershell -NoProfile -ExecutionPolicy Bypass -NonInteractive -InputFormat None -File" for PowerShell

triggers.post_download.win.extstring

Script file extension, default "cmd", use "ps1" for PowerShell

triggers.post_download.osxobject required

Mac command

triggers.post_download.osx.scriptstring required

Command

triggers.post_download.osx.shellstring

Shell, default "/bin/sh"

triggers.post_download.osx.extstring

Script file extension, default "sh"

triggers.post_download.androidobject required

Android command

triggers.post_download.android.scriptstring required

Command

triggers.post_download.android.shellstring

Shell, default "/system/bin/sh"

triggers.post_download.android.extstring

Script file extension, default "sh"

triggers.post_download.xboxobject required

Xbox command. Only for distribution jobs

triggers.post_download.xbox.scriptstring required

Command

triggers.post_download.xbox.shellstring

Shell, default ""

triggers.post_download.xbox.extstring

Script file extension, default ""

triggers.completeobject

After all agents complete downloading

triggers.complete.linuxobject required

Linux command

triggers.complete.linux.scriptstring required

Command

triggers.complete.linux.shellstring

Shell, default "/bin/sh"

triggers.complete.linux.extstring

Script file extension, default "sh"

triggers.complete.winobject required

Windows command

triggers.complete.win.scriptstring required

Command

triggers.complete.win.shellstring

Shell, default "cmd.exe /Q /C", use "powershell -NoProfile -ExecutionPolicy Bypass -NonInteractive -InputFormat None -File" for PowerShell

triggers.complete.win.extstring

Script file extension, default "cmd", use "ps1" for PowerShell

triggers.complete.osxobject required

Mac command

triggers.complete.osx.scriptstring required

Command

triggers.complete.osx.shellstring

Shell, default "/bin/sh"

triggers.complete.osx.extstring

Script file extension, default "sh"

triggers.complete.androidobject required

Android command

triggers.complete.android.scriptstring required

Command

triggers.complete.android.shellstring

Shell, default "/system/bin/sh"

triggers.complete.android.extstring

Script file extension, default "sh"

scriptobject

Script for script job

script.linuxobject required

Linux command

script.linux.scriptstring required

Command

script.linux.shellstring

Shell, default "/bin/sh"

script.linux.extstring

Script file extension, default "sh"

script.winobject required

Windows command

script.win.scriptstring required

Command

script.win.shellstring

Shell, default "cmd.exe /Q /C", use "powershell -NoProfile -ExecutionPolicy Bypass -NonInteractive -InputFormat None -File" for PowerShell

script.win.extstring

Script file extension, default "cmd", use "ps1" for PowerShell

script.osxobject required

Mac command

script.osx.scriptstring required

Command

script.osx.shellstring

Shell, default "/bin/sh"

script.osx.extstring

Script file extension, default "sh"

script.androidobject required

Android command

script.android.scriptstring required

Command

script.android.shellstring

Shell, default "/system/bin/sh"

script.android.extstring

Script file extension, default "sh"

schedulerobject required

Scheduler. Not applicable for sync, file_caching, hybrid_work job

scheduler.typestring required

Type of the scheduler

scheduler.timenumber required

once - timestamp in seconds, daily - number of seconds since midnight, weekly - array of seconds since midnight

scheduler.everynumber required

minutes - run every N minutes(min 5 minutes), hourly - run every N hours, daily - run every N days

scheduler.daysnumber required

weekly - array of days of week to run (encoded in numbers from 0 to 6, 0 is Sunday)

scheduler.startnumber required

Scheduler start time (timestamp in seconds) for minutes, hourly, daily and weekly schedulers

scheduler.finishnumber required

Scheduler finish time (timestamp in seconds) for minutes, hourly, daily and weekly schedulers

scheduler.configobject

Job monthly scheduler configuration

scheduler.config.offsetnumber required

Specifies the position within a month When representing a day, the value range is 1–31 When representing monday, tuesday, wednesday, thursday, friday, saturday, and sunday the value range is 1–5

scheduler.config.unitstring required

Specifies the day of the month or the day of week

scheduler.config.directionstring required

Determines the reference point within the month for scheduling. month_beginning - the offset is calculated starting from the first day of the month month_end - the offset is calculated starting from the last day of the month

scheduler.config.timenumber required

Specifies the time of the day to run the job (minutes)

scheduler.skip_if_runningnumber required

Wait for job run to complete before starting new one (for all scheduler types except manually or now)

settingsobject

Job settings.

settings.prioritynumber

Job priority. Not applicable for script jobs. The lowest priority: 0, the highest: 10. Default value is 5

settings.use_ram_optimizationboolean

Use RAM-optimized configuration. Not applicable for script jobs and existing sync jobs. Not configurable and true by default for file_caching, hybrid_work jobs. Is only supported for jobs with Agents of version 3.0.0 and newer. Default value is true

settings.reference_instance_idnumber

The Reference Instance (Agent or High Availability group) propagates and overwrites file permissions on other Agents in sync, file_caching, hybrid_work jobs. Selecting a Reference Instance is required for the jobs that synchronize file permissions. Default value is null

settings.reference_instance_typestring

The Reference Instance type. Agents and High Availability groups are allowed only. Default value is null (reference instance was removed or was not specified)

settings.reference_agent_idnumber

Deprecated since 4.0. Use reference_instance_type and reference_instance_id instead. The Reference Agent propagates and overwrites file permissions on other Agents in sync, file_caching, hybrid_work jobs. Selecting a Reference Agent is required for the jobs that synchronize file permissions. Default value is null

settings.profileobject

Unique profile settings for job. If not specified, profile_id or default job profile is used

settings.delete_synced_filesboolean

Delete synced files. Only for distribution, consolidation, storage_tiering_and_archival jobs

settings.delete_synced_files_ttlnumber

Delete synced files (in days). Only for distribution, consolidation, storage_tiering_and_archival jobs

settings.archive_bystring

Criterion to archive by. Determines what field will be used settings.files_list, settings.modification_time or settings.access_time. Only one selected criterion is applied. Similar settings from profile will be ignored. If source is cloud storage access_time criterion must not be used. Only for storage_tiering_and_archival job. More information can be found here.

settings.files_liststring

List of regular expressions separated by a new line character \n to match files based on their paths. Only for storage_tiering_and_archival job. Required and must not be empty if settings.archive_by=path</code.

settings.modification_timeobject

Files will be matched based on time in seconds since they were last modified. If only settings.modification_time.min is provided files with modification time earlier than settings.modification_time.min seconds ago will be matched. If only settings.modification_time.max is provided files with modification time later than settings.modification_time.max seconds ago will be matched. If both values are provided they are treated as absolute timestamps in seconds and files with modification time between settings.modification_time.min and settings.modification_time.max will be matched. At least one value must be provided. Only for storage_tiering_and_archival job.

settings.modification_time.maxnumber

Max modification time in seconds.

settings.modification_time.minnumber

Min modification time in seconds.

settings.access_timeobject

Files will be matched based on time in seconds since they were last accessed. If only settings.access_time.min is provided files with access time earlier than settings.access_time.min seconds ago will be matched. If only settings.access_time.max is provided files with access time later than settings.access_time.max seconds ago will be matched. If both values are provided they are treated as absolute timestamps in seconds and files with access time between settings.access_time.min and settings.access_time.max will be matched. At least one value must be provided. Only for storage_tiering_and_archival job.

settings.access_time.maxnumber

Max access time in seconds.

settings.access_time.minnumber

Min access time in seconds.

settings.aws_s3_storage_classstring

Setting that will be used if job's destination is Amazon Glacier storage. Only for storage_tiering_and_archival job.

settings.aws_s3_retrieval_tierstring

Setting that will be used if job's source is Amazon Glacier storage. Only for storage_tiering_and_archival job.

settings.use_file_lockingboolean

File locks setting. Only for sync, file_caching, hybrid_work jobs

settings.file_locks_timeoutnumber

File locks timeout. Applicable only if setting.use_file_locking is true

settings.file_locks_sync_intervalnumber

File locks sync interval. Applicable only if setting.use_file_locking is true

settings.file_locks_ignore_liststring

File locks ignore list. Applicable only if setting.use_file_locking is true

settings.file_locks_allowed_access_when_no_serverstring

File locks access to files when no access to locks server. Applicable only if setting.use_file_locking is true.

settings.map_folder_to_drivestring

Map a local folder to a drive letter, applicable only for hybrid jobs on Windows end-users starting from version 4.2.0. Ensure that Agents are not assigned the same drive letter in multiple jobs. The drive letter should follow the format X:. To unmap the folder, provide an empty string

post_command_local_timenumber required

Local Agent time after an Agent run completes downloading trigger (in seconds)

pre_move_command_local_timenumber required

Local Agent time after an Agent run before finalizing download trigger (in seconds)

profile_idnumber

Job Profile id. If the parameter is not specified, default jobs profile id is used. Ignored if unique profile settings for job are specified

notificationsobject

List of job notifications

notifications.idnumber

Notification id

notifications.destinationsobject required

Array of notification destinations. One of email, user_id, web_hook_id is required

notifications.destinations.emailstring required

Email to send notifications

notifications.destinations.user_idnumber required

Id of user to send notifications

notifications.destinations.web_hook_idnumber required

Id of webhook to send notifications

notifications.triggerstring required

Notification trigger.

notifications.settingsobject required

Notification settings

notifications.settings.error_codestring required

Error code to trigger notification. Is null in case of notification is configured for any error code. Only for JOB_RUN_ERROR trigger

notifications.settings.notify_after_error_timeoutboolean required

Trigger notification after error timeout. Only for JOB_RUN_ERROR trigger

notifications.settings.error_timeoutnumber

Error timeout (seconds). Only for JOB_RUN_ERROR trigger. Minimum value is 1 minute

notifications.settings.notify_on_error_removeboolean required

Notify when error is resolved. Only for JOB_RUN_ERROR trigger

notifications.settings.complete_timeoutnumber required

Send notification if job run isn't complete within time wait period (seconds). Only for JOB_RUN_NOT_COMPLETE trigger. Minimum value is 1 minute

notifications.settings.dont_send_if_no_data_transferredboolean required

Skip notice if jobs did not transfer files. Only for JOB_RUN_FINISHED trigger

Response

Successful response

object required

Changes

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