---
title: "Create group"
method: POST
path: "/groups"
tags: ["Groups"]
---

# Create group

`POST /groups`

## Request

- Base URL: `https://localhost:8446/api/v2`
- URL: `https://localhost:8446/api/v2/groups`
- Auth: API key in header `Authorization`

Create new group. Group is created with global profile and bandwidth schedule

## Request body

- object
  - `name` string: Group name
  - `description` string: Group description
  - `type` string: Group type. Default is standard
  - `agents` object: Array of group agents
  - `agents.id` number, required: Agent id
  - `jobs` object: 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.id` number, required: Job id
  - `jobs.permission` string, required: Job permissions. Selective permissions (sro and srw) are allowed only for sync, file_caching and hybrid_work jobs
  - `jobs.path` object, required: Job path
  - `jobs.path.macro` string: 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.linux` string, required: Linux path
  - `jobs.path.linux_cache` string, required: Linux cache path. Only for caching_gateway role
  - `jobs.path.win` string, required: Windows path
  - `jobs.path.osx` string, required: OS X path
  - `jobs.path.android` string, required: Android path
  - `jobs.path.xbox` string, required: Xbox path. Only for distribution jobs
  - `jobs.role` string: 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_id` number: File policy id. Required for caching_gateway, enduser role
  - `jobs.priority_agents` boolean: Priority agents. Only for agent with primary_storage role or agent in sync job.
  - `autoadd_new_agents` boolean: Deprecated, use auto_group_type instead. Automatically add new agents
  - `auto_group_type` string: Auto group type
  - `match` object: Match agents by tag
  - `match.tag_name` string, required: Client's tag name
  - `match.tag_value` string, required: Client's tag value to match, regular expression
  - `profile_id` number: Agent Profile id. If the parameter is not specified, default agents profile id is used
  - `schedule_id` number: Bandwidth schedule id. If the parameter is not specified, default bandwidth schedule id is used

## Response `200`

Successful response

- object

## Other responses

- `default`: Error response. Depending on the error, either a 4xx or 5xx response status is returned.

---

[API](https://skmtc.dev/resilio/apis/resilio-api.md) - [All operations](https://skmtc.dev/resilio/apis/resilio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/resilio/apis/resilio-api/revisions/ca39130a395e?raw)