Servers API


Get account's servers

GET /accounts/:account/servers

Parameters

appfirst_id
required: false
Filter by appfirst ID
cluster
required: false
Filter by cluster membership
environment
required: false
Filter by environment membership
private_hostname
required: false
Filter by private hostname
provisioned_id
required: false
Filter by infrastructure ID (i.e., 'i-b28d7df2')
public_hostname
required: false
Filter by public hostname
state
required: false
Filter by instance state

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "servers": [
              {
                "id": 22,
                "created_at": "2017-02-22T17:04:27+00:00",
                "deleted_at": null,
                "deprovisioned_at": null,
                "disappeared_at": null,
                "enabled": true,
                "name": null,
                "private_hostname": "a805c636-ba7e-4c26-af00-fba659058633.engineyard.com",
                "provisioned_at": "2017-02-22T17:04:43+00:00",
                "ssh_port": 22,
                "updated_at": "2017-02-22T17:04:44+00:00",
                "provisioned_id": "i-703b6361",
                "state": "running",
                "account": "https://api.engineyard.com/accounts/4987fd5c-a6cc-4388-a72e-31d8fd674b9a",
                "address": null,
                "devices": [
                  {
                    "size": 30,
                    "delete_on_termination": true,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdb",
                    "delete_on_termination": true,
                    "size": 25,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdc",
                    "delete_on_termination": true,
                    "size": 8,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdd",
                    "name": "ephemeral0"
                  },
                  {
                    "device": "/dev/sde",
                    "name": "ephemeral1"
                  },
                  {
                    "device": "sdb",
                    "no_device": true
                  },
                  {
                    "device": "sdc",
                    "no_device": true
                  },
                  {
                    "device": "sdd",
                    "no_device": true
                  },
                  {
                    "device": "sde",
                    "no_device": true
                  }
                ],
                "environment": "https://api.engineyard.com/environments/4",
                "events": "https://api.engineyard.com/servers/22/events",
                "firewalls": "https://api.engineyard.com/servers/22/firewalls",
                "flavor": {
                  "id": "m4_large"
                },
                "iam_role": null,
                "location": "us-west-2c",
                "logs": "https://api.engineyard.com/servers/22/logs",
                "provider": "https://api.engineyard.com/providers/7",
                "public_hostname": "a901e2c8-2162-4d5c-9cab-0bf4f34bcd2c.engineyard.com",
                "server_alerts": "https://api.engineyard.com/servers/22/server-alerts",
                "snapshots": "https://api.engineyard.com/servers/22/snapshots",
                "volumes": "https://api.engineyard.com/servers/22/volumes",
                "alerts": "https://api.engineyard.com/servers/22/alerts",
                "role": "app",
                "release_label": null,
                "dedicated": false,
                "chef_status": [
                  {
                    "message": "Instance fully configured and ready",
                    "timestamp": "2017-02-22T17:04:44+00:00",
                    "time_ago": "less than a minute"
                  }
                ],
                "no_deploy": false
              },
              {
                "id": 23,
                "created_at": "2017-02-22T17:04:27+00:00",
                "deleted_at": null,
                "deprovisioned_at": null,
                "disappeared_at": null,
                "enabled": true,
                "name": null,
                "private_hostname": "342b15b8-7e19-443c-b2ff-018b14a6769e.engineyard.com",
                "provisioned_at": "2017-02-22T17:04:47+00:00",
                "ssh_port": 22,
                "updated_at": "2017-02-22T17:04:50+00:00",
                "provisioned_id": "i-67c94513",
                "state": "running",
                "account": "https://api.engineyard.com/accounts/4987fd5c-a6cc-4388-a72e-31d8fd674b9a",
                "address": null,
                "devices": [
                  {
                    "size": 30,
                    "delete_on_termination": true,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdb",
                    "delete_on_termination": true,
                    "size": 25,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdc",
                    "delete_on_termination": true,
                    "size": 8,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdd",
                    "name": "ephemeral0"
                  },
                  {
                    "device": "/dev/sde",
                    "name": "ephemeral1"
                  },
                  {
                    "device": "sdb",
                    "no_device": true
                  },
                  {
                    "device": "sdc",
                    "no_device": true
                  },
                  {
                    "device": "sdd",
                    "no_device": true
                  },
                  {
                    "device": "sde",
                    "no_device": true
                  }
                ],
                "environment": "https://api.engineyard.com/environments/4",
                "events": "https://api.engineyard.com/servers/23/events",
                "firewalls": "https://api.engineyard.com/servers/23/firewalls",
                "flavor": {
                  "id": "m4_large"
                },
                "iam_role": null,
                "location": "us-west-2b",
                "logs": "https://api.engineyard.com/servers/23/logs",
                "provider": "https://api.engineyard.com/providers/7",
                "public_hostname": "74494ab5-bfc8-4e2a-838f-fe7e9145976a.engineyard.com",
                "server_alerts": "https://api.engineyard.com/servers/23/server-alerts",
                "snapshots": "https://api.engineyard.com/servers/23/snapshots",
                "volumes": "https://api.engineyard.com/servers/23/volumes",
                "alerts": "https://api.engineyard.com/servers/23/alerts",
                "role": "db_slave",
                "release_label": null,
                "dedicated": false,
                "chef_status": [
                  {
                    "message": "Instance fully configured and ready",
                    "timestamp": "2017-02-22T17:04:49+00:00",
                    "time_ago": "less than a minute"
                  }
                ],
                "no_deploy": false
              },
              {
                "id": 19,
                "created_at": "2017-02-22T17:04:26+00:00",
                "deleted_at": null,
                "deprovisioned_at": null,
                "disappeared_at": null,
                "enabled": true,
                "name": null,
                "private_hostname": "91cf9025-a7c9-4b51-aea5-32d88f9a91c5.engineyard.com",
                "provisioned_at": "2017-02-22T17:04:36+00:00",
                "ssh_port": 22,
                "updated_at": "2017-02-22T17:04:47+00:00",
                "provisioned_id": "i-74fc3be8",
                "state": "running",
                "account": "https://api.engineyard.com/accounts/4987fd5c-a6cc-4388-a72e-31d8fd674b9a",
                "address": null,
                "devices": [
                  {
                    "size": 30,
                    "delete_on_termination": true,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdb",
                    "delete_on_termination": true,
                    "size": 25,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdc",
                    "delete_on_termination": true,
                    "size": 8,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdd",
                    "name": "ephemeral0"
                  },
                  {
                    "device": "/dev/sde",
                    "name": "ephemeral1"
                  },
                  {
                    "device": "sdb",
                    "no_device": true
                  },
                  {
                    "device": "sdc",
                    "no_device": true
                  },
                  {
                    "device": "sdd",
                    "no_device": true
                  },
                  {
                    "device": "sde",
                    "no_device": true
                  }
                ],
                "environment": "https://api.engineyard.com/environments/4",
                "events": "https://api.engineyard.com/servers/19/events",
                "firewalls": "https://api.engineyard.com/servers/19/firewalls",
                "flavor": {
                  "id": "m4_large"
                },
                "iam_role": null,
                "location": "us-west-2c",
                "logs": "https://api.engineyard.com/servers/19/logs",
                "provider": "https://api.engineyard.com/providers/7",
                "public_hostname": "6dd1f728-3580-44af-87bb-4711e7494e78.engineyard.com",
                "server_alerts": "https://api.engineyard.com/servers/19/server-alerts",
                "snapshots": "https://api.engineyard.com/servers/19/snapshots",
                "volumes": "https://api.engineyard.com/servers/19/volumes",
                "alerts": "https://api.engineyard.com/servers/19/alerts",
                "role": "db_master",
                "release_label": null,
                "dedicated": false,
                "chef_status": [
                  {
                    "message": "Snapshot /db complete",
                    "timestamp": "2017-02-22T17:04:47+00:00",
                    "time_ago": "less than a minute"
                  }
                ],
                "no_deploy": false
              },
              {
                "id": 20,
                "created_at": "2017-02-22T17:04:26+00:00",
                "deleted_at": null,
                "deprovisioned_at": null,
                "disappeared_at": null,
                "enabled": true,
                "name": null,
                "private_hostname": "f5a77890-22af-4a9c-99ee-2bdde42d79cf.engineyard.com",
                "provisioned_at": "2017-02-22T17:04:32+00:00",
                "ssh_port": 22,
                "updated_at": "2017-02-22T17:04:35+00:00",
                "provisioned_id": "i-c968f44e",
                "state": "running",
                "account": "https://api.engineyard.com/accounts/4987fd5c-a6cc-4388-a72e-31d8fd674b9a",
                "address": "https://api.engineyard.com/addresses/4",
                "devices": [
                  {
                    "size": 30,
                    "delete_on_termination": true,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdb",
                    "delete_on_termination": true,
                    "size": 25,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdc",
                    "delete_on_termination": true,
                    "size": 8,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdd",
                    "name": "ephemeral0"
                  },
                  {
                    "device": "/dev/sde",
                    "name": "ephemeral1"
                  },
                  {
                    "device": "sdb",
                    "no_device": true
                  },
                  {
                    "device": "sdc",
                    "no_device": true
                  },
                  {
                    "device": "sdd",
                    "no_device": true
                  },
                  {
                    "device": "sde",
                    "no_device": true
                  }
                ],
                "environment": "https://api.engineyard.com/environments/4",
                "events": "https://api.engineyard.com/servers/20/events",
                "firewalls": "https://api.engineyard.com/servers/20/firewalls",
                "flavor": {
                  "id": "m4_large"
                },
                "iam_role": null,
                "location": "us-west-2a",
                "logs": "https://api.engineyard.com/servers/20/logs",
                "provider": "https://api.engineyard.com/providers/7",
                "public_hostname": "b02bddbc-eaff-46b4-89ad-0090ff9f2681.engineyard.com",
                "server_alerts": "https://api.engineyard.com/servers/20/server-alerts",
                "snapshots": "https://api.engineyard.com/servers/20/snapshots",
                "volumes": "https://api.engineyard.com/servers/20/volumes",
                "alerts": "https://api.engineyard.com/servers/20/alerts",
                "role": "app_master",
                "release_label": null,
                "dedicated": false,
                "chef_status": [
                  {
                    "message": "Instance fully configured and ready",
                    "timestamp": "2017-02-22T17:04:34+00:00",
                    "time_ago": "less than a minute"
                  }
                ],
                "no_deploy": false
              },
              {
                "id": 21,
                "created_at": "2017-02-22T17:04:26+00:00",
                "deleted_at": null,
                "deprovisioned_at": null,
                "disappeared_at": null,
                "enabled": true,
                "name": null,
                "private_hostname": "28c6dea5-059c-42f5-8405-3b63bd7b2dba.engineyard.com",
                "provisioned_at": "2017-02-22T17:04:40+00:00",
                "ssh_port": 22,
                "updated_at": "2017-02-22T17:04:41+00:00",
                "provisioned_id": "i-99ee964c",
                "state": "running",
                "account": "https://api.engineyard.com/accounts/4987fd5c-a6cc-4388-a72e-31d8fd674b9a",
                "address": null,
                "devices": [
                  {
                    "size": 30,
                    "delete_on_termination": true,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdb",
                    "delete_on_termination": true,
                    "size": 25,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdc",
                    "delete_on_termination": true,
                    "size": 8,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdd",
                    "name": "ephemeral0"
                  },
                  {
                    "device": "/dev/sde",
                    "name": "ephemeral1"
                  },
                  {
                    "device": "sdb",
                    "no_device": true
                  },
                  {
                    "device": "sdc",
                    "no_device": true
                  },
                  {
                    "device": "sdd",
                    "no_device": true
                  },
                  {
                    "device": "sde",
                    "no_device": true
                  }
                ],
                "environment": "https://api.engineyard.com/environments/4",
                "events": "https://api.engineyard.com/servers/21/events",
                "firewalls": "https://api.engineyard.com/servers/21/firewalls",
                "flavor": {
                  "id": "m4_large"
                },
                "iam_role": null,
                "location": "us-west-2b",
                "logs": "https://api.engineyard.com/servers/21/logs",
                "provider": "https://api.engineyard.com/providers/7",
                "public_hostname": "eac2bea7-e177-4a40-b30f-d939d9819987.engineyard.com",
                "server_alerts": "https://api.engineyard.com/servers/21/server-alerts",
                "snapshots": "https://api.engineyard.com/servers/21/snapshots",
                "volumes": "https://api.engineyard.com/servers/21/volumes",
                "alerts": "https://api.engineyard.com/servers/21/alerts",
                "role": "app",
                "release_label": null,
                "dedicated": false,
                "chef_status": [
                  {
                    "message": "Instance fully configured and ready",
                    "timestamp": "2017-02-22T17:04:41+00:00",
                    "time_ago": "less than a minute"
                  }
                ],
                "no_deploy": false
              }
            ]
          }
            
          








Stop a server

PUT /servers/:server/stop

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "stop_server",
              "id": "1f31cffe-5049-4018-8a95-95170e66e143",
              "created_at": "2017-02-22T17:08:01+00:00",
              "started_at": "2017-02-22T17:08:01+00:00",
              "finished_at": "2017-02-22T17:08:05+00:00",
              "message": null,
              "request_status": "Finished:  (1f31cffe-5049-4018-8a95-95170e66e143) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:08:05+00:00",
              "read_channel": null,
              "stage": "update-and-apply",
              "dependencies": "https://api.engineyard.com/requests/1f31cffe-5049-4018-8a95-95170e66e143/dependencies",
              "stages": "https://api.engineyard.com/requests/1f31cffe-5049-4018-8a95-95170e66e143/stages",
              "account": "https://api.engineyard.com/accounts/79058a9a-c22d-4eed-a586-1e674de1f06c",
              "requester": "https://api.engineyard.com/requests/1f31cffe-5049-4018-8a95-95170e66e143/requester",
              "messages": "https://api.engineyard.com/requests/1f31cffe-5049-4018-8a95-95170e66e143/messages",
              "callback_url": "https://api.engineyard.com/requests/1f31cffe-5049-4018-8a95-95170e66e143/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/servers/45"
            }
          }
            
          








Add a dedicated server to an environment

POST /servers

Parameters

environment
required: true
Environment ID
role
required: true
scope: server
Role of the new server (app, db_slave, util)
location
required: false
scope: server
Availability zone for the new server
name
required: false
scope: server
Name of the server. Required for utility servers
flavor
required: true
scope: server
Size of the new server
dedicated
required: false
scope: server
Should the new instance have dedicated tenancy
iam_role_id
required: false
scope: server
ID of the IAM role to boot the server with

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "environment": 2,
            "server": {
              "name": "new_util",
              "flavor": "c4.large",
              "role": "util",
              "dedicated": true
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "provision_server",
              "id": "c7142f40-047d-430f-9f0e-1850ca0c5279",
              "created_at": "2017-02-22T17:03:23+00:00",
              "started_at": "2017-02-22T17:03:23+00:00",
              "finished_at": "2017-02-22T17:03:33+00:00",
              "message": null,
              "request_status": "Finished: Provision server (c7142f40-047d-430f-9f0e-1850ca0c5279) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:03:33+00:00",
              "read_channel": null,
              "stage": "server.bootstrapped",
              "dependencies": "https://api.engineyard.com/requests/c7142f40-047d-430f-9f0e-1850ca0c5279/dependencies",
              "stages": "https://api.engineyard.com/requests/c7142f40-047d-430f-9f0e-1850ca0c5279/stages",
              "account": "https://api.engineyard.com/accounts/177c7e67-7d56-41f7-9dea-46e59196978d",
              "requester": "https://api.engineyard.com/requests/c7142f40-047d-430f-9f0e-1850ca0c5279/requester",
              "messages": "https://api.engineyard.com/requests/c7142f40-047d-430f-9f0e-1850ca0c5279/messages",
              "callback_url": "https://api.engineyard.com/requests/c7142f40-047d-430f-9f0e-1850ca0c5279/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/servers/12"
            }
          }
            
          








List servers

GET /servers

Parameters

appfirst_id
required: false
Filter by appfirst ID
account
required: false
Filter by account
cluster
required: false
Filter by cluster membership
environment
required: false
Filter by environment membership
private_hostname
required: false
Filter by private hostname
provisioned_id
required: false
Filter by infrastructure ID (i.e., 'i-b28d7df2')
public_hostname
required: false
Filter by public hostname
state
required: false
Filter by instance state

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "servers": [
              {
                "id": 27,
                "created_at": "2017-02-22T17:05:00+00:00",
                "deleted_at": null,
                "deprovisioned_at": null,
                "disappeared_at": null,
                "enabled": true,
                "name": null,
                "private_hostname": "b29b1e85-4178-46ed-aee1-c66a1d1a6282.engineyard.com",
                "provisioned_at": "2017-02-22T17:05:19+00:00",
                "ssh_port": 22,
                "updated_at": "2017-02-22T17:05:21+00:00",
                "provisioned_id": "i-2d1134ec",
                "state": "running",
                "account": "https://api.engineyard.com/accounts/2e553a6a-2700-490f-9bab-662dbb1edb78",
                "address": null,
                "devices": [
                  {
                    "size": 30,
                    "delete_on_termination": true,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdb",
                    "delete_on_termination": true,
                    "size": 25,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdc",
                    "delete_on_termination": true,
                    "size": 8,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdd",
                    "name": "ephemeral0"
                  },
                  {
                    "device": "/dev/sde",
                    "name": "ephemeral1"
                  },
                  {
                    "device": "sdb",
                    "no_device": true
                  },
                  {
                    "device": "sdc",
                    "no_device": true
                  },
                  {
                    "device": "sdd",
                    "no_device": true
                  },
                  {
                    "device": "sde",
                    "no_device": true
                  }
                ],
                "environment": "https://api.engineyard.com/environments/5",
                "events": "https://api.engineyard.com/servers/27/events",
                "firewalls": "https://api.engineyard.com/servers/27/firewalls",
                "flavor": {
                  "id": "m4_large"
                },
                "iam_role": null,
                "location": "us-west-2a",
                "logs": "https://api.engineyard.com/servers/27/logs",
                "provider": "https://api.engineyard.com/providers/9",
                "public_hostname": "e9bc9bfb-8e70-4fed-ac9e-a04dab897965.engineyard.com",
                "server_alerts": "https://api.engineyard.com/servers/27/server-alerts",
                "snapshots": "https://api.engineyard.com/servers/27/snapshots",
                "volumes": "https://api.engineyard.com/servers/27/volumes",
                "alerts": "https://api.engineyard.com/servers/27/alerts",
                "role": "app",
                "release_label": null,
                "dedicated": false,
                "chef_status": [
                  {
                    "message": "Instance fully configured and ready",
                    "timestamp": "2017-02-22T17:05:20+00:00",
                    "time_ago": "less than a minute"
                  }
                ],
                "no_deploy": false
              },
              {
                "id": 28,
                "created_at": "2017-02-22T17:05:00+00:00",
                "deleted_at": null,
                "deprovisioned_at": null,
                "disappeared_at": null,
                "enabled": true,
                "name": null,
                "private_hostname": "661c5de3-0b1a-4a37-b2aa-70decbcf8bb3.engineyard.com",
                "provisioned_at": "2017-02-22T17:05:23+00:00",
                "ssh_port": 22,
                "updated_at": "2017-02-22T17:05:26+00:00",
                "provisioned_id": "i-77f4ac54",
                "state": "running",
                "account": "https://api.engineyard.com/accounts/2e553a6a-2700-490f-9bab-662dbb1edb78",
                "address": null,
                "devices": [
                  {
                    "size": 30,
                    "delete_on_termination": true,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdb",
                    "delete_on_termination": true,
                    "size": 25,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdc",
                    "delete_on_termination": true,
                    "size": 8,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdd",
                    "name": "ephemeral0"
                  },
                  {
                    "device": "/dev/sde",
                    "name": "ephemeral1"
                  },
                  {
                    "device": "sdb",
                    "no_device": true
                  },
                  {
                    "device": "sdc",
                    "no_device": true
                  },
                  {
                    "device": "sdd",
                    "no_device": true
                  },
                  {
                    "device": "sde",
                    "no_device": true
                  }
                ],
                "environment": "https://api.engineyard.com/environments/5",
                "events": "https://api.engineyard.com/servers/28/events",
                "firewalls": "https://api.engineyard.com/servers/28/firewalls",
                "flavor": {
                  "id": "m4_large"
                },
                "iam_role": null,
                "location": "us-west-2b",
                "logs": "https://api.engineyard.com/servers/28/logs",
                "provider": "https://api.engineyard.com/providers/9",
                "public_hostname": "4b6e06a0-9025-4252-bbe5-687ba06e8335.engineyard.com",
                "server_alerts": "https://api.engineyard.com/servers/28/server-alerts",
                "snapshots": "https://api.engineyard.com/servers/28/snapshots",
                "volumes": "https://api.engineyard.com/servers/28/volumes",
                "alerts": "https://api.engineyard.com/servers/28/alerts",
                "role": "db_slave",
                "release_label": null,
                "dedicated": false,
                "chef_status": [
                  {
                    "message": "Instance fully configured and ready",
                    "timestamp": "2017-02-22T17:05:25+00:00",
                    "time_ago": "less than a minute"
                  }
                ],
                "no_deploy": false
              },
              {
                "id": 24,
                "created_at": "2017-02-22T17:04:59+00:00",
                "deleted_at": null,
                "deprovisioned_at": null,
                "disappeared_at": null,
                "enabled": true,
                "name": null,
                "private_hostname": "3bc35d7d-110f-47d1-b3cf-f173eac7b4d6.engineyard.com",
                "provisioned_at": "2017-02-22T17:05:11+00:00",
                "ssh_port": 22,
                "updated_at": "2017-02-22T17:05:24+00:00",
                "provisioned_id": "i-e0cabbed",
                "state": "running",
                "account": "https://api.engineyard.com/accounts/2e553a6a-2700-490f-9bab-662dbb1edb78",
                "address": null,
                "devices": [
                  {
                    "size": 30,
                    "delete_on_termination": true,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdb",
                    "delete_on_termination": true,
                    "size": 25,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdc",
                    "delete_on_termination": true,
                    "size": 8,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdd",
                    "name": "ephemeral0"
                  },
                  {
                    "device": "/dev/sde",
                    "name": "ephemeral1"
                  },
                  {
                    "device": "sdb",
                    "no_device": true
                  },
                  {
                    "device": "sdc",
                    "no_device": true
                  },
                  {
                    "device": "sdd",
                    "no_device": true
                  },
                  {
                    "device": "sde",
                    "no_device": true
                  }
                ],
                "environment": "https://api.engineyard.com/environments/5",
                "events": "https://api.engineyard.com/servers/24/events",
                "firewalls": "https://api.engineyard.com/servers/24/firewalls",
                "flavor": {
                  "id": "m4_large"
                },
                "iam_role": null,
                "location": "us-west-2c",
                "logs": "https://api.engineyard.com/servers/24/logs",
                "provider": "https://api.engineyard.com/providers/9",
                "public_hostname": "e282eb6a-dce0-44a7-bf41-2cf31433063d.engineyard.com",
                "server_alerts": "https://api.engineyard.com/servers/24/server-alerts",
                "snapshots": "https://api.engineyard.com/servers/24/snapshots",
                "volumes": "https://api.engineyard.com/servers/24/volumes",
                "alerts": "https://api.engineyard.com/servers/24/alerts",
                "role": "db_master",
                "release_label": null,
                "dedicated": false,
                "chef_status": [
                  {
                    "message": "Snapshot /db complete",
                    "timestamp": "2017-02-22T17:05:24+00:00",
                    "time_ago": "less than a minute"
                  }
                ],
                "no_deploy": false
              },
              {
                "id": 25,
                "created_at": "2017-02-22T17:04:59+00:00",
                "deleted_at": null,
                "deprovisioned_at": null,
                "disappeared_at": null,
                "enabled": true,
                "name": null,
                "private_hostname": "fe747285-1926-4fa4-a2f4-477ac51346f6.engineyard.com",
                "provisioned_at": "2017-02-22T17:05:05+00:00",
                "ssh_port": 22,
                "updated_at": "2017-02-22T17:05:08+00:00",
                "provisioned_id": "i-a9a355d5",
                "state": "running",
                "account": "https://api.engineyard.com/accounts/2e553a6a-2700-490f-9bab-662dbb1edb78",
                "address": "https://api.engineyard.com/addresses/5",
                "devices": [
                  {
                    "size": 30,
                    "delete_on_termination": true,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdb",
                    "delete_on_termination": true,
                    "size": 25,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdc",
                    "delete_on_termination": true,
                    "size": 8,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdd",
                    "name": "ephemeral0"
                  },
                  {
                    "device": "/dev/sde",
                    "name": "ephemeral1"
                  },
                  {
                    "device": "sdb",
                    "no_device": true
                  },
                  {
                    "device": "sdc",
                    "no_device": true
                  },
                  {
                    "device": "sdd",
                    "no_device": true
                  },
                  {
                    "device": "sde",
                    "no_device": true
                  }
                ],
                "environment": "https://api.engineyard.com/environments/5",
                "events": "https://api.engineyard.com/servers/25/events",
                "firewalls": "https://api.engineyard.com/servers/25/firewalls",
                "flavor": {
                  "id": "m4_large"
                },
                "iam_role": null,
                "location": "us-west-2c",
                "logs": "https://api.engineyard.com/servers/25/logs",
                "provider": "https://api.engineyard.com/providers/9",
                "public_hostname": "ed8e5c62-38a6-4159-8e74-91e1fccec7eb.engineyard.com",
                "server_alerts": "https://api.engineyard.com/servers/25/server-alerts",
                "snapshots": "https://api.engineyard.com/servers/25/snapshots",
                "volumes": "https://api.engineyard.com/servers/25/volumes",
                "alerts": "https://api.engineyard.com/servers/25/alerts",
                "role": "app_master",
                "release_label": null,
                "dedicated": false,
                "chef_status": [
                  {
                    "message": "Instance fully configured and ready",
                    "timestamp": "2017-02-22T17:05:08+00:00",
                    "time_ago": "less than a minute"
                  }
                ],
                "no_deploy": false
              },
              {
                "id": 26,
                "created_at": "2017-02-22T17:04:59+00:00",
                "deleted_at": null,
                "deprovisioned_at": null,
                "disappeared_at": null,
                "enabled": true,
                "name": null,
                "private_hostname": "f961d9a9-a3cf-447a-b3ed-21dcfad1f33a.engineyard.com",
                "provisioned_at": "2017-02-22T17:05:16+00:00",
                "ssh_port": 22,
                "updated_at": "2017-02-22T17:05:17+00:00",
                "provisioned_id": "i-03961d80",
                "state": "running",
                "account": "https://api.engineyard.com/accounts/2e553a6a-2700-490f-9bab-662dbb1edb78",
                "address": null,
                "devices": [
                  {
                    "size": 30,
                    "delete_on_termination": true,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdb",
                    "delete_on_termination": true,
                    "size": 25,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdc",
                    "delete_on_termination": true,
                    "size": 8,
                    "volume_type": "gp2"
                  },
                  {
                    "device": "/dev/sdd",
                    "name": "ephemeral0"
                  },
                  {
                    "device": "/dev/sde",
                    "name": "ephemeral1"
                  },
                  {
                    "device": "sdb",
                    "no_device": true
                  },
                  {
                    "device": "sdc",
                    "no_device": true
                  },
                  {
                    "device": "sdd",
                    "no_device": true
                  },
                  {
                    "device": "sde",
                    "no_device": true
                  }
                ],
                "environment": "https://api.engineyard.com/environments/5",
                "events": "https://api.engineyard.com/servers/26/events",
                "firewalls": "https://api.engineyard.com/servers/26/firewalls",
                "flavor": {
                  "id": "m4_large"
                },
                "iam_role": null,
                "location": "us-west-2b",
                "logs": "https://api.engineyard.com/servers/26/logs",
                "provider": "https://api.engineyard.com/providers/9",
                "public_hostname": "ef41c7ec-6f1c-45ed-85c1-c0bab40574ef.engineyard.com",
                "server_alerts": "https://api.engineyard.com/servers/26/server-alerts",
                "snapshots": "https://api.engineyard.com/servers/26/snapshots",
                "volumes": "https://api.engineyard.com/servers/26/volumes",
                "alerts": "https://api.engineyard.com/servers/26/alerts",
                "role": "app",
                "release_label": null,
                "dedicated": false,
                "chef_status": [
                  {
                    "message": "Instance fully configured and ready",
                    "timestamp": "2017-02-22T17:05:17+00:00",
                    "time_ago": "less than a minute"
                  }
                ],
                "no_deploy": false
              }
            ]
          }
            
          








Start a server

PUT /servers/:server/start

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "start_server",
              "id": "5e334460-663a-4375-82cd-dcbd9807482e",
              "created_at": "2017-02-22T17:08:42+00:00",
              "started_at": "2017-02-22T17:08:42+00:00",
              "finished_at": "2017-02-22T17:08:47+00:00",
              "message": null,
              "request_status": "Finished:  (5e334460-663a-4375-82cd-dcbd9807482e) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:08:47+00:00",
              "read_channel": null,
              "stage": "update-and-apply",
              "dependencies": "https://api.engineyard.com/requests/5e334460-663a-4375-82cd-dcbd9807482e/dependencies",
              "stages": "https://api.engineyard.com/requests/5e334460-663a-4375-82cd-dcbd9807482e/stages",
              "account": "https://api.engineyard.com/accounts/15bd1c19-f78a-41ca-8536-fbb68e96dddb",
              "requester": "https://api.engineyard.com/requests/5e334460-663a-4375-82cd-dcbd9807482e/requester",
              "messages": "https://api.engineyard.com/requests/5e334460-663a-4375-82cd-dcbd9807482e/messages",
              "callback_url": "https://api.engineyard.com/requests/5e334460-663a-4375-82cd-dcbd9807482e/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/servers/50"
            }
          }
            
          








Get a server

GET /servers/:server

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "server": {
              "id": 30,
              "created_at": "2017-02-22T17:05:36+00:00",
              "deleted_at": null,
              "deprovisioned_at": null,
              "disappeared_at": null,
              "enabled": true,
              "name": null,
              "private_hostname": "3686aecc-d826-402e-8901-aa412539133d.engineyard.com",
              "provisioned_at": "2017-02-22T17:05:43+00:00",
              "ssh_port": 22,
              "updated_at": "2017-02-22T17:05:46+00:00",
              "provisioned_id": "i-02b9c01b",
              "state": "running",
              "account": "https://api.engineyard.com/accounts/2d810f70-8f07-4d32-8aad-ed6e26d1c447",
              "address": "https://api.engineyard.com/addresses/6",
              "devices": [
                {
                  "size": 30,
                  "delete_on_termination": true,
                  "volume_type": "gp2"
                },
                {
                  "device": "/dev/sdb",
                  "delete_on_termination": true,
                  "size": 25,
                  "volume_type": "gp2"
                },
                {
                  "device": "/dev/sdc",
                  "delete_on_termination": true,
                  "size": 8,
                  "volume_type": "gp2"
                },
                {
                  "device": "/dev/sdd",
                  "name": "ephemeral0"
                },
                {
                  "device": "/dev/sde",
                  "name": "ephemeral1"
                },
                {
                  "device": "sdb",
                  "no_device": true
                },
                {
                  "device": "sdc",
                  "no_device": true
                },
                {
                  "device": "sdd",
                  "no_device": true
                },
                {
                  "device": "sde",
                  "no_device": true
                }
              ],
              "environment": "https://api.engineyard.com/environments/6",
              "events": "https://api.engineyard.com/servers/30/events",
              "firewalls": "https://api.engineyard.com/servers/30/firewalls",
              "flavor": {
                "id": "m4_large"
              },
              "iam_role": null,
              "location": "us-west-2b",
              "logs": "https://api.engineyard.com/servers/30/logs",
              "provider": "https://api.engineyard.com/providers/11",
              "public_hostname": "2df910e5-fcd2-42cc-89b0-eb067728729d.engineyard.com",
              "server_alerts": "https://api.engineyard.com/servers/30/server-alerts",
              "snapshots": "https://api.engineyard.com/servers/30/snapshots",
              "volumes": "https://api.engineyard.com/servers/30/volumes",
              "alerts": "https://api.engineyard.com/servers/30/alerts",
              "role": "app_master",
              "release_label": null,
              "dedicated": false,
              "chef_status": [
                {
                  "message": "Instance fully configured and ready",
                  "timestamp": "2017-02-22T17:05:46+00:00",
                  "time_ago": "less than a minute"
                }
              ],
              "no_deploy": false
            }
          }
            
          








Apply updates to a server

POST /servers/:server/apply

Parameters

type
required: false
Type of chef run

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "instance_update",
              "id": "0c9acbd6-5463-4817-9e9c-c556e2ba1d8c",
              "created_at": "2017-02-22T17:07:24+00:00",
              "started_at": "2017-02-22T17:07:24+00:00",
              "finished_at": "2017-02-22T17:07:25+00:00",
              "message": null,
              "successful": true,
              "updated_at": "2017-02-22T17:07:25+00:00",
              "read_channel": null,
              "stage": null,
              "dependencies": null,
              "stages": null,
              "account": "https://api.engineyard.com/accounts/222bb43e-8b04-4c4c-bc43-8d5755534b84",
              "requester": "https://api.engineyard.com/requests/0c9acbd6-5463-4817-9e9c-c556e2ba1d8c/requester",
              "messages": "https://api.engineyard.com/requests/0c9acbd6-5463-4817-9e9c-c556e2ba1d8c/messages",
              "callback_url": "https://api.engineyard.com/requests/0c9acbd6-5463-4817-9e9c-c556e2ba1d8c/callback",
              "progress": false,
              "resource": false
            }
          }
            
          








Deprovision a server

DELETE /servers/:server

Parameters

skip_snapshot
required: false
Choose whether or not a snapshot should be taken before destroying the server. Default is true

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "deprovision_server",
              "id": "18a95f62-17b5-435c-b171-e8f966cd8937",
              "created_at": "2017-02-22T17:06:41+00:00",
              "started_at": "2017-02-22T17:06:42+00:00",
              "finished_at": "2017-02-22T17:06:44+00:00",
              "message": null,
              "request_status": "Finished: Deprovision server (18a95f62-17b5-435c-b171-e8f966cd8937) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:06:44+00:00",
              "read_channel": null,
              "stage": "alerts.finish",
              "dependencies": "https://api.engineyard.com/requests/18a95f62-17b5-435c-b171-e8f966cd8937/dependencies",
              "stages": "https://api.engineyard.com/requests/18a95f62-17b5-435c-b171-e8f966cd8937/stages",
              "account": "https://api.engineyard.com/accounts/c4320541-b767-457a-9872-8fc5cd17fde8",
              "requester": "https://api.engineyard.com/requests/18a95f62-17b5-435c-b171-e8f966cd8937/requester",
              "messages": "https://api.engineyard.com/requests/18a95f62-17b5-435c-b171-e8f966cd8937/messages",
              "callback_url": "https://api.engineyard.com/requests/18a95f62-17b5-435c-b171-e8f966cd8937/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/servers/36"
            }
          }
            
          








Add a server to an environment

POST /servers

Parameters

environment
required: true
Environment ID
role
required: true
scope: server
Role of the new server (app, db_slave, util)
location
required: false
scope: server
Availability zone for the new server
name
required: false
scope: server
Name of the server. Required for utility servers
flavor
required: true
scope: server
Size of the new server
dedicated
required: false
scope: server
Should the new instance have dedicated tenancy
iam_role_id
required: false
scope: server
ID of the IAM role to boot the server with

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "environment": 1,
            "server": {
              "name": "new_util",
              "flavor": "m3.large",
              "role": "util"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "provision_server",
              "id": "7ad42f23-9348-47cd-9acf-565216f2bd06",
              "created_at": "2017-02-22T17:02:38+00:00",
              "started_at": "2017-02-22T17:02:38+00:00",
              "finished_at": "2017-02-22T17:02:45+00:00",
              "message": null,
              "request_status": "Finished: Provision server (7ad42f23-9348-47cd-9acf-565216f2bd06) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:02:45+00:00",
              "read_channel": null,
              "stage": "server.bootstrapped",
              "dependencies": "https://api.engineyard.com/requests/7ad42f23-9348-47cd-9acf-565216f2bd06/dependencies",
              "stages": "https://api.engineyard.com/requests/7ad42f23-9348-47cd-9acf-565216f2bd06/stages",
              "account": "https://api.engineyard.com/accounts/20151977-0598-4201-88d6-00a952e80706",
              "requester": "https://api.engineyard.com/requests/7ad42f23-9348-47cd-9acf-565216f2bd06/requester",
              "messages": "https://api.engineyard.com/requests/7ad42f23-9348-47cd-9acf-565216f2bd06/messages",
              "callback_url": "https://api.engineyard.com/requests/7ad42f23-9348-47cd-9acf-565216f2bd06/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/servers/6"
            }
          }
            
          








Add a server with an assigned IAM role

POST /servers

Parameters

environment
required: true
Environment ID
role
required: true
scope: server
Role of the new server (app, db_slave, util)
location
required: false
scope: server
Availability zone for the new server
name
required: false
scope: server
Name of the server. Required for utility servers
flavor
required: true
scope: server
Size of the new server
dedicated
required: false
scope: server
Should the new instance have dedicated tenancy
iam_role_id
required: false
scope: server
ID of the IAM role to boot the server with

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "environment": 3,
            "server": {
              "name": "new_util",
              "flavor": "c4.large",
              "role": "util",
              "iam_role_id": "6b33a8a3-470c-4ab4-9780-bf887cd56cf4"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "provision_server",
              "id": "00dfae52-d521-4dfa-8c14-5fa48a358bd2",
              "created_at": "2017-02-22T17:04:10+00:00",
              "started_at": "2017-02-22T17:04:10+00:00",
              "finished_at": "2017-02-22T17:04:17+00:00",
              "message": null,
              "request_status": "Finished: Provision server (00dfae52-d521-4dfa-8c14-5fa48a358bd2) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:04:17+00:00",
              "read_channel": null,
              "stage": "server.bootstrapped",
              "dependencies": "https://api.engineyard.com/requests/00dfae52-d521-4dfa-8c14-5fa48a358bd2/dependencies",
              "stages": "https://api.engineyard.com/requests/00dfae52-d521-4dfa-8c14-5fa48a358bd2/stages",
              "account": "https://api.engineyard.com/accounts/1266f08e-689c-4b72-82b9-bf890b5d4663",
              "requester": "https://api.engineyard.com/requests/00dfae52-d521-4dfa-8c14-5fa48a358bd2/requester",
              "messages": "https://api.engineyard.com/requests/00dfae52-d521-4dfa-8c14-5fa48a358bd2/messages",
              "callback_url": "https://api.engineyard.com/requests/00dfae52-d521-4dfa-8c14-5fa48a358bd2/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/servers/18"
            }
          }