Header

Listing all server groups via API

This method will return a list of all servers which are configured for your project.

URL

/projects/<project>/server_groups

HTTP Method

GET

Replace <project> with the permalink of the project.

Supported Parameters

None

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
https://test.deployhq.com/projects/project/server_groups

Example JSON

{
  "name": "My Server Group",
  "preferred_branch": "master",
  "last_revision": "e84b5937f1132932dd56026db26a76f406555c19",
  "identifier": "7563d091-ca73-588e-cfe2-e4936f190145",
  "servers" : [
      {
        "name": "My Server",
        "server_path": "/var/www/my-project",
        "port": 22,
        "username": "dan",
        "use_ssh_keys": false,
        "last_revision": "e84b5937f1132932dd56026db26a76f406555c19",
        "hostname": "host.example.com",
        "identifier": "7563d091-ca73-588e-cfe2-e4936f190145",
        "protocol_type": "ssh"
      }
  ]
}
Tree

Proudly powered by Katapult. Running on 100% renewable energy.