REresilio
Groups

Update group

Update group. Any group param listed below can be updated.

put/groups/{id}

Request

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

Path parameters

idnumber required

Group id

Request body

namestring

Group name

descriptionstring

Group description

agentsobject

Array of group agents

agents.idnumber required

Agent id

jobsobject

Array of group jobs NOTE: Specifying jobs in the group route is deprecated since 4.2.0. Use the update job route for this purpose.

jobs.idnumber required

Job id

jobs.permissionstring required

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

jobs.pathobject required

Job path

jobs.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

jobs.path.linuxstring required

Linux path

jobs.path.linux_cachestring required

Linux cache path. Only for caching_gateway role

jobs.path.winstring required

Windows path

jobs.path.osxstring required

OS X path

jobs.path.androidstring required

Android path

jobs.path.xboxstring required

Xbox path. Only for distribution jobs

jobs.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.

jobs.file_policy_idnumber

File policy id. Required for caching_gateway, enduser role

jobs.priority_agentsboolean

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

autoadd_new_agentsboolean

Deprecated, use auto_group_type instead. Automatically add new agents

auto_group_typestring

Auto group type

matchobject

Match agents by tag

match.tag_namestring required

Client's tag name

match.tag_valuestring required

Client's tag value to match, regular expression

profile_idnumber

Agent Profile id

schedule_idnumber

Bandwidth schedule id

Response

Successful response

object required

Changes

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