# Group

Group purpose is to group Services in logical groups.


## List Groups

 - [GET /hubs/{subdomain}/groups](https://api-docs.statushub.com/api-v3-openapi/group/listgroups.md): Filters and returns Groups for current Hub. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub.

## Create a Group

 - [POST /hubs/{subdomain}/groups](https://api-docs.statushub.com/api-v3-openapi/group/creategroup.md): Creates a new group. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub.

## Retrieve a Group

 - [GET /hubs/{subdomain}/groups/{group_id}](https://api-docs.statushub.com/api-v3-openapi/group/getgroup.md): Returns data about single group. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub.

## Update a Group

 - [PUT /hubs/{subdomain}/groups/{group_id}](https://api-docs.statushub.com/api-v3-openapi/group/updategroup.md): Updates existing group. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub.

## Delete a Group

 - [DELETE /hubs/{subdomain}/groups/{group_id}](https://api-docs.statushub.com/api-v3-openapi/group/deletegroup.md): Deletes existing group and all its services.
Request valid only in the scope of Primary or Standalone Hub and can't
be used in the scope of a Connected Hub.

Deleting a group also deletes:
- All services in that group,
- Events if there are events that after deleting this group with
  its services would be left without any other services.

## Archive a Group

 - [PUT /hubs/{subdomain}/groups/{group_id}/archive](https://api-docs.statushub.com/api-v3-openapi/group/archivegroup.md): Archives existing group and all its services.
Request valid only in scope of Primary or Standalone Hub and can't
be used in scope of a Connected Hub.

Deleting a group also archives:
- All services in that group,
- Events if there are events that after deleting this group with
  its services would be left without any other services.

The difference between deleting and archiving can be summarized by:
- Both archived and deleted records are not visible on Hub Page,
- Unlike deleted records, archived records are still visible in Control
  Panel but as a read-only records.

## Update a Group position

 - [PUT /hubs/{subdomain}/groups/{group_id}/reorder](https://api-docs.statushub.com/api-v3-openapi/group/reordergroup.md): Updates position of existing group. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub.