REresilio
Groups

Get group by id

Returns group info.

get/groups/{id}

Request

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

Path parameters

idnumber required

Group id

Response

Successful response

idnumber required

Group id

namestring required

Group name

descriptionstring required

Group description

typestring required

Group type

accessstring required

Group access

agentsobject required

Group agents

agents.idnumber required

Agent id

jobsobject required

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

jobs.pathobject required

Job path

jobs.path.macrostring

Macro. If the parameter is not specified, custom path is used

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

jobs.rolestring required

Role

jobs.file_policy_idnumber required

File policy id. Only for caching_gateway, enduser role

jobs.priority_agentsboolean

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

jobs.lock_serverboolean

Locks server. Is only present if group is lock server in sync, file_caching or hybrid_work job. Only for the case when setting.use_file_locking is true for group with primary_storage role or group in sync job. Can not be changed via group API. To change the value use the update job route.

autoadd_new_agentsboolean required

Deprecated, use auto_group_type instead. Automatically add new agents.

auto_group_typestring required

Auto group type

matchobject required

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

peer_idstring

Group peer id (in case high_availability or gateway_scale_out type is selected)

schedule_idnumber

Bandwidth schedule id

Changes

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