---
title: "List server groups"
method: GET
path: "/projects/{project_id}/server_groups"
tags: ["Server Groups"]
---

# List server groups

`GET /projects/{project_id}/server_groups`

## Request

- Base URL: `https://sg.deployhq.com`
- URL: `https://sg.deployhq.com/projects/{project_id}/server_groups`
- Auth: HTTP basic

Returns all server groups for the project, ordered ascending.

## Path parameters

- `project_id` string, required

## Response `200`

Success

- object[]
  - `identifier` string
  - `name` string
  - `servers` object[]
    - `id` integer
    - `identifier` string
    - `name` string
    - `protocol_type` string
    - `server_path` string
    - `last_revision` string
    - `preferred_branch` string
    - `branch` string
    - `notify_email` string
    - `server_group_identifier` string
    - `auto_deploy` boolean
    - `environment` string
    - `enabled` boolean
    - `agent` string, nullable
    - `atomic` boolean
    - `atomic_strategy` string
    - `atomic_retention` integer
    - `use_compression` boolean
    - `use_accelerated_transfer` boolean
    - `use_parallel_upload` boolean
    - `root_path` string
    - `position` integer
    - `created_at` string
    - `updated_at` string
    - `connection_checked_at` string, nullable
    - `connection_error_message` string, nullable
    - `hostname` string
    - `username` string
    - `port` string
    - `use_ssh_keys` boolean
    - `host_key` string
    - `unlink_before_upload` boolean
    - `global_key_pair_id` string
  - `preferred_branch` string
  - `last_revision` string
  - `environment` string
  - `transfer_order` string

## Other responses

- `401`: You are not authorized to access this resource. You need to authenticate yourself first.
- `403`: You are not allowed to access this resource. You do not have the necessary permissions.
- `500`: An unexpected error occurred on the server. The server was unable to process the request.

---

[API](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation.md) · [All operations](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation/revisions/830264ae58be?raw)