Create job
Create new job.
Request
- Base URLhttps://localhost:8446/api/v2
- AuthAPI key in header Authorization
Query parameters
Ignore job errors, default is false
Request body
Job name
Job type
Job description
Array of job groups
Group id
Group permissions. Selective permissions (sro and srw) are allowed only for sync, file_caching and hybrid_work jobs
Group path
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
Linux path
Linux cache path. Only for group with caching_gateway role
Windows path
OS X path
Android path
Xbox path. Only for distribution jobs
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.
File policy id. Required for group with caching_gateway, enduser role
Priority agents. Only for group with primary_storage role or group in sync job.
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.
Array of job agents
Agent id
Agent permissions. Selective permissions (sro and srw) are allowed only for sync, file_caching and hybrid_work jobs
Agent path
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
Linux path
Linux cache path. Only for agent with caching_gateway role
Windows path
OS X path
Android path
Xbox path. Only for distribution jobs
Storage connector config id If the parameter is not specified, Storage connector isn't used
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.
File policy id. Required for agent with caching_gateway, enduser role
Priority agents. Only for agent with primary_storage role or agent in sync job.
Locks server. Only for the case when setting.use_file_locking is true for agent with primary_storage role or agent in sync job.
Job triggers. Only for distribution, consolidation, storage_tiering_and_archival jobs
Before file-indexing begins
Linux command
Command
Shell, default "/bin/sh"
Script file extension, default "sh"
Windows command
Command
Shell, default "cmd.exe /Q /C", use "powershell -NoProfile -ExecutionPolicy Bypass -NonInteractive -InputFormat None -File" for PowerShell
Script file extension, default "cmd", use "ps1" for PowerShell
Mac command
Command
Shell, default "/bin/sh"
Script file extension, default "sh"
Before an agent finalizing download. Only for distribution jobs
Linux command
Command
Shell, default "/bin/sh"
Script file extension, default "sh"
Windows command
Command
Shell, default "cmd.exe /Q /C", use "powershell -NoProfile -ExecutionPolicy Bypass -NonInteractive -InputFormat None -File" for PowerShell
Script file extension, default "cmd", use "ps1" for PowerShell
Mac command
Command
Shell, default "/bin/sh"
Script file extension, default "sh"
After an agent completes downloading
Linux command
Command
Shell, default "/bin/sh"
Script file extension, default "sh"
Windows command
Command
Shell, default "cmd.exe /Q /C", use "powershell -NoProfile -ExecutionPolicy Bypass -NonInteractive -InputFormat None -File" for PowerShell
Script file extension, default "cmd", use "ps1" for PowerShell
Mac command
Command
Shell, default "/bin/sh"
Script file extension, default "sh"
After all agents complete downloading
Linux command
Command
Shell, default "/bin/sh"
Script file extension, default "sh"
Windows command
Command
Shell, default "cmd.exe /Q /C", use "powershell -NoProfile -ExecutionPolicy Bypass -NonInteractive -InputFormat None -File" for PowerShell
Script file extension, default "cmd", use "ps1" for PowerShell
Mac command
Command
Shell, default "/bin/sh"
Script file extension, default "sh"
Script for script job
Linux command
Command
Shell, default "/bin/sh"
Script file extension, default "sh"
Windows command
Command
Shell, default "cmd.exe /Q /C", use "powershell -NoProfile -ExecutionPolicy Bypass -NonInteractive -InputFormat None -File" for PowerShell
Script file extension, default "cmd", use "ps1" for PowerShell
Mac command
Command
Shell, default "/bin/sh"
Script file extension, default "sh"
Scheduler. Not applicable for sync, file_caching, hybrid_work job
Type of the scheduler
once - timestamp in seconds, daily - number of seconds since midnight, weekly - array of seconds since midnight
minutes - run every N minutes(min 5 minutes), hourly - run every N hours, daily - run every N days
weekly - array of days of week to run (encoded in numbers from 0 to 6, 0 is Sunday)
Scheduler start time (timestamp in seconds) for minutes, hourly, daily and weekly schedulers
Scheduler finish time (timestamp in seconds) for minutes, hourly, daily and weekly schedulers
Wait for job run to complete before starting new one (for all scheduler types except manually and now)
Job monthly scheduler configuration
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
Specifies the day of the month or the day of week
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
Specifies the time of the day to run the job (minutes)
Job settings.
Job priority. Not applicable for script jobs. The lowest priority: 0, the highest: 10. Default value is 5
Use RAM-optimized configuration. Not applicable for script 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
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.
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
The Reference type. Agents and High Availability groups are allowed only. Default value is null (reference instance was removed or was not specified)
Unique profile settings for job
Delete synced files. Only for distribution, consolidation, storage_tiering_and_archival jobs
Delete synced files (in days). Only for distribution, consolidation, storage_tiering_and_archival jobs
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.
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.
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.
Max modification time in seconds.
Min modification time in seconds.
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.
Max access time in seconds.
Min access time in seconds.
Setting that will be used if job's destination is Amazon Glacier storage. Only for storage_tiering_and_archival job.
Setting that will be used if job's source is Amazon Glacier storage. Only for storage_tiering_and_archival job.
File locks setting. Only for sync, file_caching, hybrid_work jobs
File locks timeout. Applicable only if setting.use_file_locking is true
File locks sync interval. Applicable only if setting.use_file_locking is true
File locks ignore list. Applicable only if setting.use_file_locking is true
File locks access to files when no access to locks server. Applicable only if setting.use_file_locking is true.
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
Use new version of cipher suite. Not configurable and true by default for file_caching, hybrid_work jobs.
Local Agent time after an Agent run completes downloading trigger (in seconds)
Local Agent time after an Agent run before finalizing download trigger (in seconds)
Job Profile id. If the parameter is not specified, default jobs profile id is used. Ignored if unique profile settings for job are specified
List of job notifications
Array of notification destinations. One of email, user_id, web_hook_id is required
Email to send notifications
Id of user to send notifications
Id of webhook to send notifications
Notification trigger.
Notification settings
Error code to trigger notification. Is null in case of notification is configured for any error code. Only for JOB_RUN_ERROR trigger
Trigger notification after error timeout. Only for JOB_RUN_ERROR trigger
Error timeout (seconds). Only for JOB_RUN_ERROR trigger. Minimum value is 1 minute
Notify when error is resolved. Only for JOB_RUN_ERROR trigger
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
Skip notice if jobs did not transfer files. Only for JOB_RUN_FINISHED trigger
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.