Environments API


Boot an environment from a blueprint

POST /environments/:environment/boot

Parameters

cluster_configuration
required: true
Hash of cluster configuration options.
configuration
required: true
Hash of specific configuration options.
type
required: true
scope: cluster_configuration
Type of configuration to boot. Valid values are solo, cluster, production, custom.
apps
required: false
scope: cluster_configuration
Hash containing information about the app instances
count
required: false
scope: apps
Number of app instances to provision
flavor
required: false
scope: apps
default: m3.medium
Flavor of the app instances
volume_size
required: false
scope: apps
Size of the app instance /data volumes
mnt_volume_size
required: false
scope: apps
Size of the app instance /mnt volume
dedicated
required: false
scope: apps
Should the app instances have dedicated tenancy
db_master
required: false
scope: cluster_configuration
Configuration for the db_master
flavor
required: false
scope: db_master
default: m3.medium
Flavor for the database master
volume_size
required: false
scope: db_master
Size of the databases /db volume
mnt_volume_size
required: false
scope: db_master
Size of the databases /mnt volume
iops
required: false
scope: db_master
Provisioned IOPS for the database servers
dedicated
required: false
scope: db_master
Should the master have dedicated tenancy
db_slaves
required: false
scope: cluster_configuration
Array containing configuration information for the database slaves
name
required: false
scope: db_slaves
Name of the replica
flavor
required: false
scope: db_slaves
default: m3.medium
Flavor for the replica
dedicated
required: false
scope: db_slaves
Should the replica have dedicated tenancy
utils
required: false
scope: cluster_configuration
Array containing configuration information for util instances
name
required: false
scope: utils
Name of the utility instance
flavor
required: false
scope: utils
Flavor of the utility instance
volume_size
required: false
scope: utils
Size of the /data volume of the utility instance
mnt_volume_size
required: false
scope: utils
Size of the /mnt volume of the utility instance
iops
required: false
scope: utils
Provisioned IOPS for the utility instance
dedicated
required: false
scope: utils
Should the util instance have dedicated tenancy

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "cluster_configuration": {
              "blueprint_id": "42ce8417-54bb-463a-889a-13fe09136386"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: 
          
            
          {
          }
            
          








Boot an environment from a blueprint with an IP specified

POST /environments/:environment/boot

This example uses a specific 'ip_id' (an actual ID), but 'host' is also a valid option is you want to use public hostname (no IP)

Parameters

cluster_configuration
required: true
Hash of cluster configuration options.
configuration
required: true
Hash of specific configuration options.
type
required: true
scope: cluster_configuration
Type of configuration to boot. Valid values are solo, cluster, production, custom.
apps
required: false
scope: cluster_configuration
Hash containing information about the app instances
count
required: false
scope: apps
Number of app instances to provision
flavor
required: false
scope: apps
default: m3.medium
Flavor of the app instances
volume_size
required: false
scope: apps
Size of the app instance /data volumes
mnt_volume_size
required: false
scope: apps
Size of the app instance /mnt volume
dedicated
required: false
scope: apps
Should the app instances have dedicated tenancy
db_master
required: false
scope: cluster_configuration
Configuration for the db_master
flavor
required: false
scope: db_master
default: m3.medium
Flavor for the database master
volume_size
required: false
scope: db_master
Size of the databases /db volume
mnt_volume_size
required: false
scope: db_master
Size of the databases /mnt volume
iops
required: false
scope: db_master
Provisioned IOPS for the database servers
dedicated
required: false
scope: db_master
Should the master have dedicated tenancy
db_slaves
required: false
scope: cluster_configuration
Array containing configuration information for the database slaves
name
required: false
scope: db_slaves
Name of the replica
flavor
required: false
scope: db_slaves
default: m3.medium
Flavor for the replica
dedicated
required: false
scope: db_slaves
Should the replica have dedicated tenancy
utils
required: false
scope: cluster_configuration
Array containing configuration information for util instances
name
required: false
scope: utils
Name of the utility instance
flavor
required: false
scope: utils
Flavor of the utility instance
volume_size
required: false
scope: utils
Size of the /data volume of the utility instance
mnt_volume_size
required: false
scope: utils
Size of the /mnt volume of the utility instance
iops
required: false
scope: utils
Provisioned IOPS for the utility instance
dedicated
required: false
scope: utils
Should the util instance have dedicated tenancy

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "cluster_configuration": {
              "blueprint_id": "9de2d513-8ae8-4e68-8ad8-f354232bb19a",
              "ip_id": 1
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: 
          
            
          {
          }
            
          








Boot an environment with a custom configuration

POST /environments/:environment/boot

This is the equivalent of selecting the 'Custom Configuration' option in the UI when booting an environment

Parameters

cluster_configuration
required: true
Hash of cluster configuration options.
configuration
required: true
Hash of specific configuration options.
type
required: true
scope: cluster_configuration
Type of configuration to boot. Valid values are solo, cluster, production, custom.
apps
required: false
scope: cluster_configuration
Hash containing information about the app instances
count
required: false
scope: apps
Number of app instances to provision
flavor
required: false
scope: apps
default: m3.medium
Flavor of the app instances
volume_size
required: false
scope: apps
Size of the app instance /data volumes
mnt_volume_size
required: false
scope: apps
Size of the app instance /mnt volume
dedicated
required: false
scope: apps
Should the app instances have dedicated tenancy
db_master
required: false
scope: cluster_configuration
Configuration for the db_master
flavor
required: false
scope: db_master
default: m3.medium
Flavor for the database master
volume_size
required: false
scope: db_master
Size of the databases /db volume
mnt_volume_size
required: false
scope: db_master
Size of the databases /mnt volume
iops
required: false
scope: db_master
Provisioned IOPS for the database servers
dedicated
required: false
scope: db_master
Should the master have dedicated tenancy
db_slaves
required: false
scope: cluster_configuration
Array containing configuration information for the database slaves
name
required: false
scope: db_slaves
Name of the replica
flavor
required: false
scope: db_slaves
default: m3.medium
Flavor for the replica
dedicated
required: false
scope: db_slaves
Should the replica have dedicated tenancy
utils
required: false
scope: cluster_configuration
Array containing configuration information for util instances
name
required: false
scope: utils
Name of the utility instance
flavor
required: false
scope: utils
Flavor of the utility instance
volume_size
required: false
scope: utils
Size of the /data volume of the utility instance
mnt_volume_size
required: false
scope: utils
Size of the /mnt volume of the utility instance
iops
required: false
scope: utils
Provisioned IOPS for the utility instance
dedicated
required: false
scope: utils
Should the util instance have dedicated tenancy

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "cluster_configuration": {
              "configuration": {
                "type": "custom",
                "apps": {
                  "count": 4,
                  "flavor": "m4.large",
                  "volume_size": "100",
                  "mnt_volume_size": "150"
                },
                "db_master": {
                  "flavor": "c4.large",
                  "volume_size": "200",
                  "iops": "2000"
                },
                "db_slaves": [
                  {
                    "name": "test",
                    "flavor": "c4.xlarge"
                  }
                ],
                "utils": [
                  {
                    "name": "redis",
                    "flavor": "r3.large",
                    "volume_size": "300",
                    "mnt_volume_size": "300",
                    "iops": "3000"
                  }
                ]
              }
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "start_environment",
              "id": "770f8672-0ef5-4840-aebd-9b56093e459f",
              "created_at": "2017-10-10T15:38:58+00:00",
              "started_at": "2017-10-10T15:38:58+00:00",
              "finished_at": "2017-10-10T15:39:30+00:00",
              "message": "provision_server:82173874-e689-4d15-8136-c69e1deb1f23 'VolumeIOPSLimit => Volume iops of 3000 is too high; maximum is 4000. (smithy/provision_volume) [63b9529f-faf9-45f1-8ae9-cd7121d6267d]'",
              "request_status": "Failed: Start environment (770f8672-0ef5-4840-aebd-9b56093e459f). Error: provision_server:82173874-e689-4d15-8136-c69e1deb1f23 'VolumeIOPSLimit => Volume iops of 3000 is too high; maximum is 4000. (smithy/provision_volume) [63b9529f-faf9-45f1-8ae9-cd7121d6267d]'",
              "successful": false,
              "updated_at": "2017-10-10T15:39:30+00:00",
              "read_channel": null,
              "stage": "start",
              "dependencies": "https://api.engineyard.com/requests/770f8672-0ef5-4840-aebd-9b56093e459f/dependencies",
              "stages": "https://api.engineyard.com/requests/770f8672-0ef5-4840-aebd-9b56093e459f/stages",
              "account": "https://api.engineyard.com/accounts/759060e9-c779-405f-b12e-98faa26d5ae5",
              "requester": "https://api.engineyard.com/requests/770f8672-0ef5-4840-aebd-9b56093e459f/requester",
              "messages": "https://api.engineyard.com/requests/770f8672-0ef5-4840-aebd-9b56093e459f/messages",
              "callback_url": "https://api.engineyard.com/requests/770f8672-0ef5-4840-aebd-9b56093e459f/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/18"
            }
          }
            
          








Boot an environment with a production configuration

POST /environments/:environment/boot

This is the equivalent of selecting the 'Production' option in the UI when booting an environment

Parameters

cluster_configuration
required: true
Hash of cluster configuration options.
configuration
required: true
Hash of specific configuration options.
type
required: true
scope: cluster_configuration
Type of configuration to boot. Valid values are solo, cluster, production, custom.
apps
required: false
scope: cluster_configuration
Hash containing information about the app instances
count
required: false
scope: apps
Number of app instances to provision
flavor
required: false
scope: apps
default: m3.medium
Flavor of the app instances
volume_size
required: false
scope: apps
Size of the app instance /data volumes
mnt_volume_size
required: false
scope: apps
Size of the app instance /mnt volume
dedicated
required: false
scope: apps
Should the app instances have dedicated tenancy
db_master
required: false
scope: cluster_configuration
Configuration for the db_master
flavor
required: false
scope: db_master
default: m3.medium
Flavor for the database master
volume_size
required: false
scope: db_master
Size of the databases /db volume
mnt_volume_size
required: false
scope: db_master
Size of the databases /mnt volume
iops
required: false
scope: db_master
Provisioned IOPS for the database servers
dedicated
required: false
scope: db_master
Should the master have dedicated tenancy
db_slaves
required: false
scope: cluster_configuration
Array containing configuration information for the database slaves
name
required: false
scope: db_slaves
Name of the replica
flavor
required: false
scope: db_slaves
default: m3.medium
Flavor for the replica
dedicated
required: false
scope: db_slaves
Should the replica have dedicated tenancy
utils
required: false
scope: cluster_configuration
Array containing configuration information for util instances
name
required: false
scope: utils
Name of the utility instance
flavor
required: false
scope: utils
Flavor of the utility instance
volume_size
required: false
scope: utils
Size of the /data volume of the utility instance
mnt_volume_size
required: false
scope: utils
Size of the /mnt volume of the utility instance
iops
required: false
scope: utils
Provisioned IOPS for the utility instance
dedicated
required: false
scope: utils
Should the util instance have dedicated tenancy

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "cluster_configuration": {
              "configuration": {
                "type": "production"
              }
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "start_environment",
              "id": "e0a61e2a-570f-460f-bd37-a9739fbd9228",
              "created_at": "2017-10-10T15:38:41+00:00",
              "started_at": "2017-10-10T15:38:41+00:00",
              "finished_at": "2017-10-10T15:38:52+00:00",
              "message": null,
              "request_status": "Finished: Start environment (e0a61e2a-570f-460f-bd37-a9739fbd9228) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:38:52+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/e0a61e2a-570f-460f-bd37-a9739fbd9228/dependencies",
              "stages": "https://api.engineyard.com/requests/e0a61e2a-570f-460f-bd37-a9739fbd9228/stages",
              "account": "https://api.engineyard.com/accounts/ad1b1963-b901-43ec-936f-e8fba95a27fa",
              "requester": "https://api.engineyard.com/requests/e0a61e2a-570f-460f-bd37-a9739fbd9228/requester",
              "messages": "https://api.engineyard.com/requests/e0a61e2a-570f-460f-bd37-a9739fbd9228/messages",
              "callback_url": "https://api.engineyard.com/requests/e0a61e2a-570f-460f-bd37-a9739fbd9228/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/17"
            }
          }
            
          








Boot an environment with a solo configuration

POST /environments/:environment/boot

This is the equivalent of selecting the 'Single Instance' option in the UI when booting an environment

Parameters

cluster_configuration
required: true
Hash of cluster configuration options.
configuration
required: true
Hash of specific configuration options.
type
required: true
scope: cluster_configuration
Type of configuration to boot. Valid values are solo, cluster, production, custom.
apps
required: false
scope: cluster_configuration
Hash containing information about the app instances
count
required: false
scope: apps
Number of app instances to provision
flavor
required: false
scope: apps
default: m3.medium
Flavor of the app instances
volume_size
required: false
scope: apps
Size of the app instance /data volumes
mnt_volume_size
required: false
scope: apps
Size of the app instance /mnt volume
dedicated
required: false
scope: apps
Should the app instances have dedicated tenancy
db_master
required: false
scope: cluster_configuration
Configuration for the db_master
flavor
required: false
scope: db_master
default: m3.medium
Flavor for the database master
volume_size
required: false
scope: db_master
Size of the databases /db volume
mnt_volume_size
required: false
scope: db_master
Size of the databases /mnt volume
iops
required: false
scope: db_master
Provisioned IOPS for the database servers
dedicated
required: false
scope: db_master
Should the master have dedicated tenancy
db_slaves
required: false
scope: cluster_configuration
Array containing configuration information for the database slaves
name
required: false
scope: db_slaves
Name of the replica
flavor
required: false
scope: db_slaves
default: m3.medium
Flavor for the replica
dedicated
required: false
scope: db_slaves
Should the replica have dedicated tenancy
utils
required: false
scope: cluster_configuration
Array containing configuration information for util instances
name
required: false
scope: utils
Name of the utility instance
flavor
required: false
scope: utils
Flavor of the utility instance
volume_size
required: false
scope: utils
Size of the /data volume of the utility instance
mnt_volume_size
required: false
scope: utils
Size of the /mnt volume of the utility instance
iops
required: false
scope: utils
Provisioned IOPS for the utility instance
dedicated
required: false
scope: utils
Should the util instance have dedicated tenancy

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "cluster_configuration": {
              "configuration": {
                "type": "solo"
              }
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "start_environment",
              "id": "e11f526d-9379-4e57-8539-ece4a6149958",
              "created_at": "2017-10-10T15:38:01+00:00",
              "started_at": "2017-10-10T15:38:01+00:00",
              "finished_at": "2017-10-10T15:38:13+00:00",
              "message": null,
              "request_status": "Finished: Start environment (e11f526d-9379-4e57-8539-ece4a6149958) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:38:13+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/e11f526d-9379-4e57-8539-ece4a6149958/dependencies",
              "stages": "https://api.engineyard.com/requests/e11f526d-9379-4e57-8539-ece4a6149958/stages",
              "account": "https://api.engineyard.com/accounts/ceee3fb1-f277-4601-a608-b99b01d3f50b",
              "requester": "https://api.engineyard.com/requests/e11f526d-9379-4e57-8539-ece4a6149958/requester",
              "messages": "https://api.engineyard.com/requests/e11f526d-9379-4e57-8539-ece4a6149958/messages",
              "callback_url": "https://api.engineyard.com/requests/e11f526d-9379-4e57-8539-ece4a6149958/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/15"
            }
          }
            
          








Boot an environment with a staging configuration

POST /environments/:environment/boot

This is the equivalent of selecting the 'Staging Configuration' option in the UI when booting an environment

Parameters

cluster_configuration
required: true
Hash of cluster configuration options.
configuration
required: true
Hash of specific configuration options.
type
required: true
scope: cluster_configuration
Type of configuration to boot. Valid values are solo, cluster, production, custom.
apps
required: false
scope: cluster_configuration
Hash containing information about the app instances
count
required: false
scope: apps
Number of app instances to provision
flavor
required: false
scope: apps
default: m3.medium
Flavor of the app instances
volume_size
required: false
scope: apps
Size of the app instance /data volumes
mnt_volume_size
required: false
scope: apps
Size of the app instance /mnt volume
dedicated
required: false
scope: apps
Should the app instances have dedicated tenancy
db_master
required: false
scope: cluster_configuration
Configuration for the db_master
flavor
required: false
scope: db_master
default: m3.medium
Flavor for the database master
volume_size
required: false
scope: db_master
Size of the databases /db volume
mnt_volume_size
required: false
scope: db_master
Size of the databases /mnt volume
iops
required: false
scope: db_master
Provisioned IOPS for the database servers
dedicated
required: false
scope: db_master
Should the master have dedicated tenancy
db_slaves
required: false
scope: cluster_configuration
Array containing configuration information for the database slaves
name
required: false
scope: db_slaves
Name of the replica
flavor
required: false
scope: db_slaves
default: m3.medium
Flavor for the replica
dedicated
required: false
scope: db_slaves
Should the replica have dedicated tenancy
utils
required: false
scope: cluster_configuration
Array containing configuration information for util instances
name
required: false
scope: utils
Name of the utility instance
flavor
required: false
scope: utils
Flavor of the utility instance
volume_size
required: false
scope: utils
Size of the /data volume of the utility instance
mnt_volume_size
required: false
scope: utils
Size of the /mnt volume of the utility instance
iops
required: false
scope: utils
Provisioned IOPS for the utility instance
dedicated
required: false
scope: utils
Should the util instance have dedicated tenancy

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "cluster_configuration": {
              "configuration": {
                "type": "cluster"
              }
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "start_environment",
              "id": "5802e120-40d1-428e-9731-33de228f8441",
              "created_at": "2017-10-10T15:38:17+00:00",
              "started_at": "2017-10-10T15:38:17+00:00",
              "finished_at": "2017-10-10T15:38:37+00:00",
              "message": null,
              "request_status": "Finished: Start environment (5802e120-40d1-428e-9731-33de228f8441) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:38:37+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/5802e120-40d1-428e-9731-33de228f8441/dependencies",
              "stages": "https://api.engineyard.com/requests/5802e120-40d1-428e-9731-33de228f8441/stages",
              "account": "https://api.engineyard.com/accounts/92584140-357d-4ba2-bb52-c4ab827aa3b9",
              "requester": "https://api.engineyard.com/requests/5802e120-40d1-428e-9731-33de228f8441/requester",
              "messages": "https://api.engineyard.com/requests/5802e120-40d1-428e-9731-33de228f8441/messages",
              "callback_url": "https://api.engineyard.com/requests/5802e120-40d1-428e-9731-33de228f8441/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/16"
            }
          }
            
          








Boot an environment with one app server and a separate database server

POST /environments/:environment/boot

Parameters

cluster_configuration
required: true
Hash of cluster configuration options.
configuration
required: true
Hash of specific configuration options.
type
required: true
scope: cluster_configuration
Type of configuration to boot. Valid values are solo, cluster, production, custom.
apps
required: false
scope: cluster_configuration
Hash containing information about the app instances
count
required: false
scope: apps
Number of app instances to provision
flavor
required: false
scope: apps
default: m3.medium
Flavor of the app instances
volume_size
required: false
scope: apps
Size of the app instance /data volumes
mnt_volume_size
required: false
scope: apps
Size of the app instance /mnt volume
dedicated
required: false
scope: apps
Should the app instances have dedicated tenancy
db_master
required: false
scope: cluster_configuration
Configuration for the db_master
flavor
required: false
scope: db_master
default: m3.medium
Flavor for the database master
volume_size
required: false
scope: db_master
Size of the databases /db volume
mnt_volume_size
required: false
scope: db_master
Size of the databases /mnt volume
iops
required: false
scope: db_master
Provisioned IOPS for the database servers
dedicated
required: false
scope: db_master
Should the master have dedicated tenancy
db_slaves
required: false
scope: cluster_configuration
Array containing configuration information for the database slaves
name
required: false
scope: db_slaves
Name of the replica
flavor
required: false
scope: db_slaves
default: m3.medium
Flavor for the replica
dedicated
required: false
scope: db_slaves
Should the replica have dedicated tenancy
utils
required: false
scope: cluster_configuration
Array containing configuration information for util instances
name
required: false
scope: utils
Name of the utility instance
flavor
required: false
scope: utils
Flavor of the utility instance
volume_size
required: false
scope: utils
Size of the /data volume of the utility instance
mnt_volume_size
required: false
scope: utils
Size of the /mnt volume of the utility instance
iops
required: false
scope: utils
Provisioned IOPS for the utility instance
dedicated
required: false
scope: utils
Should the util instance have dedicated tenancy

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "cluster_configuration": {
              "configuration": {
                "type": "custom",
                "apps": {
                  "count": 1,
                  "flavor": "m4.large",
                  "volume_size": "100",
                  "mnt_volume_size": "150"
                },
                "db_master": {
                  "flavor": "c4.large",
                  "volume_size": "200",
                  "iops": "2000"
                },
                "db_slaves": [
          
                ],
                "utils": [
          
                ]
              }
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "start_environment",
              "id": "8a3570f4-410d-4b76-924d-58ec53d61605",
              "created_at": "2017-10-10T15:39:34+00:00",
              "started_at": "2017-10-10T15:39:34+00:00",
              "finished_at": "2017-10-10T15:39:48+00:00",
              "message": null,
              "request_status": "Finished: Start environment (8a3570f4-410d-4b76-924d-58ec53d61605) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:39:48+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/8a3570f4-410d-4b76-924d-58ec53d61605/dependencies",
              "stages": "https://api.engineyard.com/requests/8a3570f4-410d-4b76-924d-58ec53d61605/stages",
              "account": "https://api.engineyard.com/accounts/ccc14f7f-e631-496d-9259-24c31bee0ed6",
              "requester": "https://api.engineyard.com/requests/8a3570f4-410d-4b76-924d-58ec53d61605/requester",
              "messages": "https://api.engineyard.com/requests/8a3570f4-410d-4b76-924d-58ec53d61605/messages",
              "callback_url": "https://api.engineyard.com/requests/8a3570f4-410d-4b76-924d-58ec53d61605/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/19"
            }
          }
            
          








Create an environment

POST /accounts/:account/environments

Parameters

account
required: false
Account to assign the environment to
application_id
required: true
scope: environment
Id of the application to associate with this environment
database_backup_interval
required: false
How often to run backups (in hours)
database_backup_limit
required: false
Number of logical database backups to keep
database_stack
required: false
scope: environment
default: postgres9_4
Database stack name. Valid values are: ["mysql", "mysql5_1", "mysql5_5", "mysql5_6", "mysql5_7", "aurora5_6", "mariadb10_0", "postgres", "postgres9", "postgres9_1", "postgres9_2", "postgres9_3", "postgres9_4", "postgres9_5", "postgres9_6", "no_db"]
deploy_method
required: false
scope: environment
default: serverside
Default deployment method for the environment. Valid values are chef, serverside, none
encrypted_database_ebs
required: false
scope: environment
Should the database volumes be encrypted
encrypted_ebs_for_everything
required: false
scope: environment
Should the volumes for all servers be encrypted. This setting will take precedence over encrypted_database_ebs
framework_env
required: false
scope: environment
default: production
Framework for the environment. Production, staging, development, etc
language
required: false
scope: environment
default: Ruby 2.2
Language and version to support. Valid values are: Ruby 1.9.3, Ruby 2.0.0, Ruby 2.1.2, Ruby 2.1.5, Ruby 2.2, Ruby 2.3, PHP, Node.js
lock_db_version
required: false
scope: environment
Prevent database version changes
name
required: true
scope: environment
Name of the environment
network_id
required: false
scope: environment
Network ID to associate with this environment
region
required: false
scope: environment
Region for the environment
snapshot_limit
required: false
scope: environment
Number of snapshots to keep
snapshot_retention
required: false
scope: environment
Number of days to keep the snapshots
takeover_preference
required: false
scope: environment
default: snapshot
How to handle takeovers. Valid values: [snapshot, new_volume, no_slave, disable]

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "environment": {
              "name": "newenvironment",
              "application_id": 22
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environment": {
              "id": 6,
              "account": "https://api.engineyard.com/accounts/44f6fa96-fad7-4b9d-8974-e6f56d1ebad4",
              "alerts": "https://api.engineyard.com/environments/6/server-alerts",
              "applications": "https://api.engineyard.com/environments/6/applications",
              "classic": true,
              "created_at": "2017-10-10T15:37:33+00:00",
              "database_services": "https://api.engineyard.com/environments/6/database-services",
              "deleted_at": null,
              "firewall": null,
              "internal_private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEoAIBAAKCAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGw\nL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0\nmAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KK\nP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWV\neLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93\nKFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCewwIBIwKCAQB+0sLxaiayUX9G4oAF\nPwc6Z39n5kugk4EAVYSDzhhyIkeox/dv6oBbgMrTV4VW7QXjTH4J6UGCbZvlFZPu\n0voG/LyIAWLPb956mY0iYm8HEOtnjllrOhUZqtYmbrohOGhvlhH8mGlCSYejfjnO\nUHu5h38AXfRsr9EyYhCQl+pyhHeDZwM0MQm5459XTmoSjW7AcFaE4qn0CD0VGeQ9\nDlbH2zCcQU3+Ljpvla+ME5yN3qeppKd/bQQp3FT7MpxdDcEGDHtnkAEhggbRcXJ+\nrBw5F8GN2j8f5jZdflnb8FHVI+iAiTLfBc74V1+z5n+XnkwbtagjQpU1MpyeKp5R\nPGPTAoGBAORa/BsN7zYqw0wsCSQv3kpkGjZNnVO8PUxThVddpLJiDZI1xyWOPCrW\nlwdk8cPC2uNwc83HY/u3qMARLwfcOQdNWtvjZWwYjWjulh2b884FFVgMopPGKPpc\nNzNxdsXRajEWbw8eK8Sv6j/qF9wpMMwCFB8h0pMBorJo8V65zPktAoGBANha/+/h\n5pmkJ49kmbwyCPUBt3Z/vB6+SlsBIOcN9gWJYoaNbWeJIehMcJaoNtVArYwKIEM9\nUPhySPxmXXzPO0ux0igNA77CbOzFjR05EbGB5rRbKNd92fw8KV/tWucTPthRV/k8\nWPWOJhfIFj3MOVjopaHUqFvimlvXhuAwlw2vAoGAVNFWUzEPtQiRrpQDZTZZ4R3d\n2afMuLOhvUOX7UAJ+R0a+8rU8LEsSmz2RJM1OhUsuuCgCpqEOOxx4PBwjeQVLpkT\nHnkIafp9qqHCuoph3s6wKASxahZm/ee8u1YHi03IW2AanzcXkjK2F71ZUcYoEUKZ\nwmul/BaM4y5LBe09gR8CgYA3ol8RzF/eXWlCIS7Ynybf6n+iINiaMO6MbgEleJ5Z\nMfTDg3PnbGfOBQcCK0FMx30VYbCGUZh6ZofL387llF+0YOzlujQpvPdwFYqvvje/\n7jQCfddNWuBILLounB6wcqnCmJL28kLCzMf3fJgBQySwdlZ6Ehyp6c/ruxQNw1oK\n1QKBgDDNm9MBRY8OTKCQKj9HJx7Gh3zFKHIIBAjZlEdcwgzjsNi8+HsQuDiTkroe\nxhXjGNCek0vwr81HAa0wbEFPF1ohxkICUavo10SAMeLZQGRGhYV6oxCpD415oZI2\n0sZlQjRBG6S4zkBIk9R7+RMz3YGpey/SnNFWhhrBKBMPU0VW\n-----END RSA PRIVATE KEY-----",
              "internal_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGwL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0mAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KKP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWVeLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93KFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCeww==",
              "keypairs": "https://api.engineyard.com/environments/6/keypairs",
              "logical_databases": "https://api.engineyard.com/environments/6/logical-databases",
              "monitor_url": null,
              "name": "newenvironment",
              "server_alerts": "https://api.engineyard.com/environments/6/server-alerts",
              "servers": "https://api.engineyard.com/environments/6/servers",
              "service_level": "default",
              "service_plan": null,
              "snapshots": "https://api.engineyard.com/environments/6/snapshots",
              "updated_at": "2017-10-10T15:37:33+00:00",
              "auto_scaling_group": null,
              "available_upgrade_web_uri": null,
              "custom_recipes": null,
              "database_backup_interval": 24,
              "database_backup_limit": 10,
              "database_stack": "postgres9_4",
              "deploy_method": "serverside",
              "deployments": "https://api.engineyard.com/environments/6/deployments",
              "encrypted_database_ebs": false,
              "encrypted_ebs_for_everything": false,
              "framework_env": "production",
              "kubey_cluster": "https://api.engineyard.com/environments/6/kubey_cluster",
              "kubey_logical_database_count": null,
              "kubey_master_count": 0,
              "kubey_node_count": 0,
              "language": "Ruby 2.2",
              "lock_db_version": true,
              "network": null,
              "region": "us-east-1",
              "release_label": "stable-v4-2.0.107",
              "requests": "https://api.engineyard.com/environments/6/requests",
              "snapshot_limit": 10,
              "snapshot_retention": 90,
              "stack_name": "nginx_passenger4",
              "takeover_preference": "snapshot",
              "upgrade_available": false,
              "username": "deploy",
              "vpc_name": null,
              "vpc_provisioned_id": null
            }
          }
            
          








Create an environment with a custom database stack

POST /accounts/:account/environments

Parameters

account
required: false
Account to assign the environment to
application_id
required: true
scope: environment
Id of the application to associate with this environment
database_backup_interval
required: false
How often to run backups (in hours)
database_backup_limit
required: false
Number of logical database backups to keep
database_stack
required: false
scope: environment
default: postgres9_4
Database stack name. Valid values are: ["mysql", "mysql5_1", "mysql5_5", "mysql5_6", "mysql5_7", "aurora5_6", "mariadb10_0", "postgres", "postgres9", "postgres9_1", "postgres9_2", "postgres9_3", "postgres9_4", "postgres9_5", "postgres9_6", "no_db"]
deploy_method
required: false
scope: environment
default: serverside
Default deployment method for the environment. Valid values are chef, serverside, none
encrypted_database_ebs
required: false
scope: environment
Should the database volumes be encrypted
encrypted_ebs_for_everything
required: false
scope: environment
Should the volumes for all servers be encrypted. This setting will take precedence over encrypted_database_ebs
framework_env
required: false
scope: environment
default: production
Framework for the environment. Production, staging, development, etc
language
required: false
scope: environment
default: Ruby 2.2
Language and version to support. Valid values are: Ruby 1.9.3, Ruby 2.0.0, Ruby 2.1.2, Ruby 2.1.5, Ruby 2.2, Ruby 2.3, PHP, Node.js
lock_db_version
required: false
scope: environment
Prevent database version changes
name
required: true
scope: environment
Name of the environment
network_id
required: false
scope: environment
Network ID to associate with this environment
region
required: false
scope: environment
Region for the environment
snapshot_limit
required: false
scope: environment
Number of snapshots to keep
snapshot_retention
required: false
scope: environment
Number of days to keep the snapshots
takeover_preference
required: false
scope: environment
default: snapshot
How to handle takeovers. Valid values: [snapshot, new_volume, no_slave, disable]

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "environment": {
              "name": "042b2403",
              "application_id": 26,
              "database_stack": "postgres9_3"
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environment": {
              "id": 10,
              "account": "https://api.engineyard.com/accounts/3ec0c52a-6044-418a-8fd5-6c79777d64fd",
              "alerts": "https://api.engineyard.com/environments/10/server-alerts",
              "applications": "https://api.engineyard.com/environments/10/applications",
              "classic": true,
              "created_at": "2017-10-10T15:37:43+00:00",
              "database_services": "https://api.engineyard.com/environments/10/database-services",
              "deleted_at": null,
              "firewall": null,
              "internal_private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEoAIBAAKCAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGw\nL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0\nmAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KK\nP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWV\neLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93\nKFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCewwIBIwKCAQB+0sLxaiayUX9G4oAF\nPwc6Z39n5kugk4EAVYSDzhhyIkeox/dv6oBbgMrTV4VW7QXjTH4J6UGCbZvlFZPu\n0voG/LyIAWLPb956mY0iYm8HEOtnjllrOhUZqtYmbrohOGhvlhH8mGlCSYejfjnO\nUHu5h38AXfRsr9EyYhCQl+pyhHeDZwM0MQm5459XTmoSjW7AcFaE4qn0CD0VGeQ9\nDlbH2zCcQU3+Ljpvla+ME5yN3qeppKd/bQQp3FT7MpxdDcEGDHtnkAEhggbRcXJ+\nrBw5F8GN2j8f5jZdflnb8FHVI+iAiTLfBc74V1+z5n+XnkwbtagjQpU1MpyeKp5R\nPGPTAoGBAORa/BsN7zYqw0wsCSQv3kpkGjZNnVO8PUxThVddpLJiDZI1xyWOPCrW\nlwdk8cPC2uNwc83HY/u3qMARLwfcOQdNWtvjZWwYjWjulh2b884FFVgMopPGKPpc\nNzNxdsXRajEWbw8eK8Sv6j/qF9wpMMwCFB8h0pMBorJo8V65zPktAoGBANha/+/h\n5pmkJ49kmbwyCPUBt3Z/vB6+SlsBIOcN9gWJYoaNbWeJIehMcJaoNtVArYwKIEM9\nUPhySPxmXXzPO0ux0igNA77CbOzFjR05EbGB5rRbKNd92fw8KV/tWucTPthRV/k8\nWPWOJhfIFj3MOVjopaHUqFvimlvXhuAwlw2vAoGAVNFWUzEPtQiRrpQDZTZZ4R3d\n2afMuLOhvUOX7UAJ+R0a+8rU8LEsSmz2RJM1OhUsuuCgCpqEOOxx4PBwjeQVLpkT\nHnkIafp9qqHCuoph3s6wKASxahZm/ee8u1YHi03IW2AanzcXkjK2F71ZUcYoEUKZ\nwmul/BaM4y5LBe09gR8CgYA3ol8RzF/eXWlCIS7Ynybf6n+iINiaMO6MbgEleJ5Z\nMfTDg3PnbGfOBQcCK0FMx30VYbCGUZh6ZofL387llF+0YOzlujQpvPdwFYqvvje/\n7jQCfddNWuBILLounB6wcqnCmJL28kLCzMf3fJgBQySwdlZ6Ehyp6c/ruxQNw1oK\n1QKBgDDNm9MBRY8OTKCQKj9HJx7Gh3zFKHIIBAjZlEdcwgzjsNi8+HsQuDiTkroe\nxhXjGNCek0vwr81HAa0wbEFPF1ohxkICUavo10SAMeLZQGRGhYV6oxCpD415oZI2\n0sZlQjRBG6S4zkBIk9R7+RMz3YGpey/SnNFWhhrBKBMPU0VW\n-----END RSA PRIVATE KEY-----",
              "internal_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGwL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0mAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KKP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWVeLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93KFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCeww==",
              "keypairs": "https://api.engineyard.com/environments/10/keypairs",
              "logical_databases": "https://api.engineyard.com/environments/10/logical-databases",
              "monitor_url": null,
              "name": "042b2403",
              "server_alerts": "https://api.engineyard.com/environments/10/server-alerts",
              "servers": "https://api.engineyard.com/environments/10/servers",
              "service_level": "default",
              "service_plan": null,
              "snapshots": "https://api.engineyard.com/environments/10/snapshots",
              "updated_at": "2017-10-10T15:37:43+00:00",
              "auto_scaling_group": null,
              "available_upgrade_web_uri": null,
              "custom_recipes": null,
              "database_backup_interval": 24,
              "database_backup_limit": 10,
              "database_stack": "postgres9_3",
              "deploy_method": "serverside",
              "deployments": "https://api.engineyard.com/environments/10/deployments",
              "encrypted_database_ebs": false,
              "encrypted_ebs_for_everything": false,
              "framework_env": "production",
              "kubey_cluster": "https://api.engineyard.com/environments/10/kubey_cluster",
              "kubey_logical_database_count": null,
              "kubey_master_count": 0,
              "kubey_node_count": 0,
              "language": "Ruby 2.2",
              "lock_db_version": true,
              "network": null,
              "region": "us-east-1",
              "release_label": "stable-v4-2.0.107",
              "requests": "https://api.engineyard.com/environments/10/requests",
              "snapshot_limit": 10,
              "snapshot_retention": 90,
              "stack_name": "nginx_passenger4",
              "takeover_preference": "snapshot",
              "upgrade_available": false,
              "username": "deploy",
              "vpc_name": null,
              "vpc_provisioned_id": null
            }
          }
            
          








Create an environment with a custom framework environment

POST /accounts/:account/environments

Parameters

account
required: false
Account to assign the environment to
application_id
required: true
scope: environment
Id of the application to associate with this environment
database_backup_interval
required: false
How often to run backups (in hours)
database_backup_limit
required: false
Number of logical database backups to keep
database_stack
required: false
scope: environment
default: postgres9_4
Database stack name. Valid values are: ["mysql", "mysql5_1", "mysql5_5", "mysql5_6", "mysql5_7", "aurora5_6", "mariadb10_0", "postgres", "postgres9", "postgres9_1", "postgres9_2", "postgres9_3", "postgres9_4", "postgres9_5", "postgres9_6", "no_db"]
deploy_method
required: false
scope: environment
default: serverside
Default deployment method for the environment. Valid values are chef, serverside, none
encrypted_database_ebs
required: false
scope: environment
Should the database volumes be encrypted
encrypted_ebs_for_everything
required: false
scope: environment
Should the volumes for all servers be encrypted. This setting will take precedence over encrypted_database_ebs
framework_env
required: false
scope: environment
default: production
Framework for the environment. Production, staging, development, etc
language
required: false
scope: environment
default: Ruby 2.2
Language and version to support. Valid values are: Ruby 1.9.3, Ruby 2.0.0, Ruby 2.1.2, Ruby 2.1.5, Ruby 2.2, Ruby 2.3, PHP, Node.js
lock_db_version
required: false
scope: environment
Prevent database version changes
name
required: true
scope: environment
Name of the environment
network_id
required: false
scope: environment
Network ID to associate with this environment
region
required: false
scope: environment
Region for the environment
snapshot_limit
required: false
scope: environment
Number of snapshots to keep
snapshot_retention
required: false
scope: environment
Number of days to keep the snapshots
takeover_preference
required: false
scope: environment
default: snapshot
How to handle takeovers. Valid values: [snapshot, new_volume, no_slave, disable]

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "environment": {
              "name": "d3a9c52f",
              "application_id": 23,
              "framework_env": "testing"
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environment": {
              "id": 7,
              "account": "https://api.engineyard.com/accounts/a026ae9d-ce0e-450b-b6fc-7c44ebdd9a41",
              "alerts": "https://api.engineyard.com/environments/7/server-alerts",
              "applications": "https://api.engineyard.com/environments/7/applications",
              "classic": true,
              "created_at": "2017-10-10T15:37:35+00:00",
              "database_services": "https://api.engineyard.com/environments/7/database-services",
              "deleted_at": null,
              "firewall": null,
              "internal_private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEoAIBAAKCAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGw\nL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0\nmAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KK\nP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWV\neLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93\nKFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCewwIBIwKCAQB+0sLxaiayUX9G4oAF\nPwc6Z39n5kugk4EAVYSDzhhyIkeox/dv6oBbgMrTV4VW7QXjTH4J6UGCbZvlFZPu\n0voG/LyIAWLPb956mY0iYm8HEOtnjllrOhUZqtYmbrohOGhvlhH8mGlCSYejfjnO\nUHu5h38AXfRsr9EyYhCQl+pyhHeDZwM0MQm5459XTmoSjW7AcFaE4qn0CD0VGeQ9\nDlbH2zCcQU3+Ljpvla+ME5yN3qeppKd/bQQp3FT7MpxdDcEGDHtnkAEhggbRcXJ+\nrBw5F8GN2j8f5jZdflnb8FHVI+iAiTLfBc74V1+z5n+XnkwbtagjQpU1MpyeKp5R\nPGPTAoGBAORa/BsN7zYqw0wsCSQv3kpkGjZNnVO8PUxThVddpLJiDZI1xyWOPCrW\nlwdk8cPC2uNwc83HY/u3qMARLwfcOQdNWtvjZWwYjWjulh2b884FFVgMopPGKPpc\nNzNxdsXRajEWbw8eK8Sv6j/qF9wpMMwCFB8h0pMBorJo8V65zPktAoGBANha/+/h\n5pmkJ49kmbwyCPUBt3Z/vB6+SlsBIOcN9gWJYoaNbWeJIehMcJaoNtVArYwKIEM9\nUPhySPxmXXzPO0ux0igNA77CbOzFjR05EbGB5rRbKNd92fw8KV/tWucTPthRV/k8\nWPWOJhfIFj3MOVjopaHUqFvimlvXhuAwlw2vAoGAVNFWUzEPtQiRrpQDZTZZ4R3d\n2afMuLOhvUOX7UAJ+R0a+8rU8LEsSmz2RJM1OhUsuuCgCpqEOOxx4PBwjeQVLpkT\nHnkIafp9qqHCuoph3s6wKASxahZm/ee8u1YHi03IW2AanzcXkjK2F71ZUcYoEUKZ\nwmul/BaM4y5LBe09gR8CgYA3ol8RzF/eXWlCIS7Ynybf6n+iINiaMO6MbgEleJ5Z\nMfTDg3PnbGfOBQcCK0FMx30VYbCGUZh6ZofL387llF+0YOzlujQpvPdwFYqvvje/\n7jQCfddNWuBILLounB6wcqnCmJL28kLCzMf3fJgBQySwdlZ6Ehyp6c/ruxQNw1oK\n1QKBgDDNm9MBRY8OTKCQKj9HJx7Gh3zFKHIIBAjZlEdcwgzjsNi8+HsQuDiTkroe\nxhXjGNCek0vwr81HAa0wbEFPF1ohxkICUavo10SAMeLZQGRGhYV6oxCpD415oZI2\n0sZlQjRBG6S4zkBIk9R7+RMz3YGpey/SnNFWhhrBKBMPU0VW\n-----END RSA PRIVATE KEY-----",
              "internal_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGwL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0mAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KKP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWVeLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93KFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCeww==",
              "keypairs": "https://api.engineyard.com/environments/7/keypairs",
              "logical_databases": "https://api.engineyard.com/environments/7/logical-databases",
              "monitor_url": null,
              "name": "d3a9c52f",
              "server_alerts": "https://api.engineyard.com/environments/7/server-alerts",
              "servers": "https://api.engineyard.com/environments/7/servers",
              "service_level": "default",
              "service_plan": null,
              "snapshots": "https://api.engineyard.com/environments/7/snapshots",
              "updated_at": "2017-10-10T15:37:35+00:00",
              "auto_scaling_group": null,
              "available_upgrade_web_uri": null,
              "custom_recipes": null,
              "database_backup_interval": 24,
              "database_backup_limit": 10,
              "database_stack": "postgres9_4",
              "deploy_method": "serverside",
              "deployments": "https://api.engineyard.com/environments/7/deployments",
              "encrypted_database_ebs": false,
              "encrypted_ebs_for_everything": false,
              "framework_env": "testing",
              "kubey_cluster": "https://api.engineyard.com/environments/7/kubey_cluster",
              "kubey_logical_database_count": null,
              "kubey_master_count": 0,
              "kubey_node_count": 0,
              "language": "Ruby 2.2",
              "lock_db_version": true,
              "network": null,
              "region": "us-east-1",
              "release_label": "stable-v4-2.0.107",
              "requests": "https://api.engineyard.com/environments/7/requests",
              "snapshot_limit": 10,
              "snapshot_retention": 90,
              "stack_name": "nginx_passenger4",
              "takeover_preference": "snapshot",
              "upgrade_available": false,
              "username": "deploy",
              "vpc_name": null,
              "vpc_provisioned_id": null
            }
          }
            
          








Create an environment with a custom language

POST /accounts/:account/environments

Parameters

account
required: false
Account to assign the environment to
application_id
required: true
scope: environment
Id of the application to associate with this environment
database_backup_interval
required: false
How often to run backups (in hours)
database_backup_limit
required: false
Number of logical database backups to keep
database_stack
required: false
scope: environment
default: postgres9_4
Database stack name. Valid values are: ["mysql", "mysql5_1", "mysql5_5", "mysql5_6", "mysql5_7", "aurora5_6", "mariadb10_0", "postgres", "postgres9", "postgres9_1", "postgres9_2", "postgres9_3", "postgres9_4", "postgres9_5", "postgres9_6", "no_db"]
deploy_method
required: false
scope: environment
default: serverside
Default deployment method for the environment. Valid values are chef, serverside, none
encrypted_database_ebs
required: false
scope: environment
Should the database volumes be encrypted
encrypted_ebs_for_everything
required: false
scope: environment
Should the volumes for all servers be encrypted. This setting will take precedence over encrypted_database_ebs
framework_env
required: false
scope: environment
default: production
Framework for the environment. Production, staging, development, etc
language
required: false
scope: environment
default: Ruby 2.2
Language and version to support. Valid values are: Ruby 1.9.3, Ruby 2.0.0, Ruby 2.1.2, Ruby 2.1.5, Ruby 2.2, Ruby 2.3, PHP, Node.js
lock_db_version
required: false
scope: environment
Prevent database version changes
name
required: true
scope: environment
Name of the environment
network_id
required: false
scope: environment
Network ID to associate with this environment
region
required: false
scope: environment
Region for the environment
snapshot_limit
required: false
scope: environment
Number of snapshots to keep
snapshot_retention
required: false
scope: environment
Number of days to keep the snapshots
takeover_preference
required: false
scope: environment
default: snapshot
How to handle takeovers. Valid values: [snapshot, new_volume, no_slave, disable]

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "environment": {
              "name": "58171179",
              "application_id": 25,
              "language": "Ruby 2.1.5"
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environment": {
              "id": 9,
              "account": "https://api.engineyard.com/accounts/18846500-e28c-49c2-98d0-78733e3315d8",
              "alerts": "https://api.engineyard.com/environments/9/server-alerts",
              "applications": "https://api.engineyard.com/environments/9/applications",
              "classic": true,
              "created_at": "2017-10-10T15:37:40+00:00",
              "database_services": "https://api.engineyard.com/environments/9/database-services",
              "deleted_at": null,
              "firewall": null,
              "internal_private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEoAIBAAKCAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGw\nL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0\nmAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KK\nP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWV\neLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93\nKFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCewwIBIwKCAQB+0sLxaiayUX9G4oAF\nPwc6Z39n5kugk4EAVYSDzhhyIkeox/dv6oBbgMrTV4VW7QXjTH4J6UGCbZvlFZPu\n0voG/LyIAWLPb956mY0iYm8HEOtnjllrOhUZqtYmbrohOGhvlhH8mGlCSYejfjnO\nUHu5h38AXfRsr9EyYhCQl+pyhHeDZwM0MQm5459XTmoSjW7AcFaE4qn0CD0VGeQ9\nDlbH2zCcQU3+Ljpvla+ME5yN3qeppKd/bQQp3FT7MpxdDcEGDHtnkAEhggbRcXJ+\nrBw5F8GN2j8f5jZdflnb8FHVI+iAiTLfBc74V1+z5n+XnkwbtagjQpU1MpyeKp5R\nPGPTAoGBAORa/BsN7zYqw0wsCSQv3kpkGjZNnVO8PUxThVddpLJiDZI1xyWOPCrW\nlwdk8cPC2uNwc83HY/u3qMARLwfcOQdNWtvjZWwYjWjulh2b884FFVgMopPGKPpc\nNzNxdsXRajEWbw8eK8Sv6j/qF9wpMMwCFB8h0pMBorJo8V65zPktAoGBANha/+/h\n5pmkJ49kmbwyCPUBt3Z/vB6+SlsBIOcN9gWJYoaNbWeJIehMcJaoNtVArYwKIEM9\nUPhySPxmXXzPO0ux0igNA77CbOzFjR05EbGB5rRbKNd92fw8KV/tWucTPthRV/k8\nWPWOJhfIFj3MOVjopaHUqFvimlvXhuAwlw2vAoGAVNFWUzEPtQiRrpQDZTZZ4R3d\n2afMuLOhvUOX7UAJ+R0a+8rU8LEsSmz2RJM1OhUsuuCgCpqEOOxx4PBwjeQVLpkT\nHnkIafp9qqHCuoph3s6wKASxahZm/ee8u1YHi03IW2AanzcXkjK2F71ZUcYoEUKZ\nwmul/BaM4y5LBe09gR8CgYA3ol8RzF/eXWlCIS7Ynybf6n+iINiaMO6MbgEleJ5Z\nMfTDg3PnbGfOBQcCK0FMx30VYbCGUZh6ZofL387llF+0YOzlujQpvPdwFYqvvje/\n7jQCfddNWuBILLounB6wcqnCmJL28kLCzMf3fJgBQySwdlZ6Ehyp6c/ruxQNw1oK\n1QKBgDDNm9MBRY8OTKCQKj9HJx7Gh3zFKHIIBAjZlEdcwgzjsNi8+HsQuDiTkroe\nxhXjGNCek0vwr81HAa0wbEFPF1ohxkICUavo10SAMeLZQGRGhYV6oxCpD415oZI2\n0sZlQjRBG6S4zkBIk9R7+RMz3YGpey/SnNFWhhrBKBMPU0VW\n-----END RSA PRIVATE KEY-----",
              "internal_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGwL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0mAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KKP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWVeLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93KFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCeww==",
              "keypairs": "https://api.engineyard.com/environments/9/keypairs",
              "logical_databases": "https://api.engineyard.com/environments/9/logical-databases",
              "monitor_url": null,
              "name": "58171179",
              "server_alerts": "https://api.engineyard.com/environments/9/server-alerts",
              "servers": "https://api.engineyard.com/environments/9/servers",
              "service_level": "default",
              "service_plan": null,
              "snapshots": "https://api.engineyard.com/environments/9/snapshots",
              "updated_at": "2017-10-10T15:37:40+00:00",
              "auto_scaling_group": null,
              "available_upgrade_web_uri": null,
              "custom_recipes": null,
              "database_backup_interval": 24,
              "database_backup_limit": 10,
              "database_stack": "postgres9_4",
              "deploy_method": "serverside",
              "deployments": "https://api.engineyard.com/environments/9/deployments",
              "encrypted_database_ebs": false,
              "encrypted_ebs_for_everything": false,
              "framework_env": "production",
              "kubey_cluster": "https://api.engineyard.com/environments/9/kubey_cluster",
              "kubey_logical_database_count": null,
              "kubey_master_count": 0,
              "kubey_node_count": 0,
              "language": "Ruby 2.1.5",
              "lock_db_version": true,
              "network": null,
              "region": "us-east-1",
              "release_label": "stable-v4-2.0.107",
              "requests": "https://api.engineyard.com/environments/9/requests",
              "snapshot_limit": 10,
              "snapshot_retention": 90,
              "stack_name": "nginx_passenger4",
              "takeover_preference": "snapshot",
              "upgrade_available": false,
              "username": "deploy",
              "vpc_name": null,
              "vpc_provisioned_id": null
            }
          }
            
          








Create an environment with an associated network

POST /accounts/:account/environments

Parameters

account
required: false
Account to assign the environment to
application_id
required: true
scope: environment
Id of the application to associate with this environment
database_backup_interval
required: false
How often to run backups (in hours)
database_backup_limit
required: false
Number of logical database backups to keep
database_stack
required: false
scope: environment
default: postgres9_4
Database stack name. Valid values are: ["mysql", "mysql5_1", "mysql5_5", "mysql5_6", "mysql5_7", "aurora5_6", "mariadb10_0", "postgres", "postgres9", "postgres9_1", "postgres9_2", "postgres9_3", "postgres9_4", "postgres9_5", "postgres9_6", "no_db"]
deploy_method
required: false
scope: environment
default: serverside
Default deployment method for the environment. Valid values are chef, serverside, none
encrypted_database_ebs
required: false
scope: environment
Should the database volumes be encrypted
encrypted_ebs_for_everything
required: false
scope: environment
Should the volumes for all servers be encrypted. This setting will take precedence over encrypted_database_ebs
framework_env
required: false
scope: environment
default: production
Framework for the environment. Production, staging, development, etc
language
required: false
scope: environment
default: Ruby 2.2
Language and version to support. Valid values are: Ruby 1.9.3, Ruby 2.0.0, Ruby 2.1.2, Ruby 2.1.5, Ruby 2.2, Ruby 2.3, PHP, Node.js
lock_db_version
required: false
scope: environment
Prevent database version changes
name
required: true
scope: environment
Name of the environment
network_id
required: false
scope: environment
Network ID to associate with this environment
region
required: false
scope: environment
Region for the environment
snapshot_limit
required: false
scope: environment
Number of snapshots to keep
snapshot_retention
required: false
scope: environment
Number of days to keep the snapshots
takeover_preference
required: false
scope: environment
default: snapshot
How to handle takeovers. Valid values: [snapshot, new_volume, no_slave, disable]

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "network": "7198a8d4-4ac0-44d5-9b61-c91b0ded2460",
            "environment": {
              "name": "06a9cb84",
              "application_id": 27
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environment": {
              "id": 11,
              "account": "https://api.engineyard.com/accounts/8f7cea6d-dace-4d7c-ba57-327391c1c00e",
              "alerts": "https://api.engineyard.com/environments/11/server-alerts",
              "applications": "https://api.engineyard.com/environments/11/applications",
              "classic": true,
              "created_at": "2017-10-10T15:37:48+00:00",
              "database_services": "https://api.engineyard.com/environments/11/database-services",
              "deleted_at": null,
              "firewall": null,
              "internal_private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEoAIBAAKCAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGw\nL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0\nmAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KK\nP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWV\neLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93\nKFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCewwIBIwKCAQB+0sLxaiayUX9G4oAF\nPwc6Z39n5kugk4EAVYSDzhhyIkeox/dv6oBbgMrTV4VW7QXjTH4J6UGCbZvlFZPu\n0voG/LyIAWLPb956mY0iYm8HEOtnjllrOhUZqtYmbrohOGhvlhH8mGlCSYejfjnO\nUHu5h38AXfRsr9EyYhCQl+pyhHeDZwM0MQm5459XTmoSjW7AcFaE4qn0CD0VGeQ9\nDlbH2zCcQU3+Ljpvla+ME5yN3qeppKd/bQQp3FT7MpxdDcEGDHtnkAEhggbRcXJ+\nrBw5F8GN2j8f5jZdflnb8FHVI+iAiTLfBc74V1+z5n+XnkwbtagjQpU1MpyeKp5R\nPGPTAoGBAORa/BsN7zYqw0wsCSQv3kpkGjZNnVO8PUxThVddpLJiDZI1xyWOPCrW\nlwdk8cPC2uNwc83HY/u3qMARLwfcOQdNWtvjZWwYjWjulh2b884FFVgMopPGKPpc\nNzNxdsXRajEWbw8eK8Sv6j/qF9wpMMwCFB8h0pMBorJo8V65zPktAoGBANha/+/h\n5pmkJ49kmbwyCPUBt3Z/vB6+SlsBIOcN9gWJYoaNbWeJIehMcJaoNtVArYwKIEM9\nUPhySPxmXXzPO0ux0igNA77CbOzFjR05EbGB5rRbKNd92fw8KV/tWucTPthRV/k8\nWPWOJhfIFj3MOVjopaHUqFvimlvXhuAwlw2vAoGAVNFWUzEPtQiRrpQDZTZZ4R3d\n2afMuLOhvUOX7UAJ+R0a+8rU8LEsSmz2RJM1OhUsuuCgCpqEOOxx4PBwjeQVLpkT\nHnkIafp9qqHCuoph3s6wKASxahZm/ee8u1YHi03IW2AanzcXkjK2F71ZUcYoEUKZ\nwmul/BaM4y5LBe09gR8CgYA3ol8RzF/eXWlCIS7Ynybf6n+iINiaMO6MbgEleJ5Z\nMfTDg3PnbGfOBQcCK0FMx30VYbCGUZh6ZofL387llF+0YOzlujQpvPdwFYqvvje/\n7jQCfddNWuBILLounB6wcqnCmJL28kLCzMf3fJgBQySwdlZ6Ehyp6c/ruxQNw1oK\n1QKBgDDNm9MBRY8OTKCQKj9HJx7Gh3zFKHIIBAjZlEdcwgzjsNi8+HsQuDiTkroe\nxhXjGNCek0vwr81HAa0wbEFPF1ohxkICUavo10SAMeLZQGRGhYV6oxCpD415oZI2\n0sZlQjRBG6S4zkBIk9R7+RMz3YGpey/SnNFWhhrBKBMPU0VW\n-----END RSA PRIVATE KEY-----",
              "internal_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGwL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0mAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KKP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWVeLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93KFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCeww==",
              "keypairs": "https://api.engineyard.com/environments/11/keypairs",
              "logical_databases": "https://api.engineyard.com/environments/11/logical-databases",
              "monitor_url": null,
              "name": "06a9cb84",
              "server_alerts": "https://api.engineyard.com/environments/11/server-alerts",
              "servers": "https://api.engineyard.com/environments/11/servers",
              "service_level": "default",
              "service_plan": null,
              "snapshots": "https://api.engineyard.com/environments/11/snapshots",
              "updated_at": "2017-10-10T15:37:48+00:00",
              "auto_scaling_group": null,
              "available_upgrade_web_uri": null,
              "custom_recipes": null,
              "database_backup_interval": 24,
              "database_backup_limit": 10,
              "database_stack": "postgres9_4",
              "deploy_method": "serverside",
              "deployments": "https://api.engineyard.com/environments/11/deployments",
              "encrypted_database_ebs": false,
              "encrypted_ebs_for_everything": false,
              "framework_env": "production",
              "kubey_cluster": "https://api.engineyard.com/environments/11/kubey_cluster",
              "kubey_logical_database_count": null,
              "kubey_master_count": 0,
              "kubey_node_count": 0,
              "language": "Ruby 2.2",
              "lock_db_version": true,
              "network": "https://api.engineyard.com/networks/7198a8d4-4ac0-44d5-9b61-c91b0ded2460",
              "region": "us-east-1",
              "release_label": "stable-v4-2.0.107",
              "requests": "https://api.engineyard.com/environments/11/requests",
              "snapshot_limit": 10,
              "snapshot_retention": 90,
              "stack_name": "nginx_passenger4",
              "takeover_preference": "snapshot",
              "upgrade_available": false,
              "username": "deploy",
              "vpc_name": null,
              "vpc_provisioned_id": "vpc-1bba17fe"
            }
          }
            
          








Create an environment with encrypted EBS volumes

POST /accounts/:account/environments

Parameters

account
required: false
Account to assign the environment to
application_id
required: true
scope: environment
Id of the application to associate with this environment
database_backup_interval
required: false
How often to run backups (in hours)
database_backup_limit
required: false
Number of logical database backups to keep
database_stack
required: false
scope: environment
default: postgres9_4
Database stack name. Valid values are: ["mysql", "mysql5_1", "mysql5_5", "mysql5_6", "mysql5_7", "aurora5_6", "mariadb10_0", "postgres", "postgres9", "postgres9_1", "postgres9_2", "postgres9_3", "postgres9_4", "postgres9_5", "postgres9_6", "no_db"]
deploy_method
required: false
scope: environment
default: serverside
Default deployment method for the environment. Valid values are chef, serverside, none
encrypted_database_ebs
required: false
scope: environment
Should the database volumes be encrypted
encrypted_ebs_for_everything
required: false
scope: environment
Should the volumes for all servers be encrypted. This setting will take precedence over encrypted_database_ebs
framework_env
required: false
scope: environment
default: production
Framework for the environment. Production, staging, development, etc
language
required: false
scope: environment
default: Ruby 2.2
Language and version to support. Valid values are: Ruby 1.9.3, Ruby 2.0.0, Ruby 2.1.2, Ruby 2.1.5, Ruby 2.2, Ruby 2.3, PHP, Node.js
lock_db_version
required: false
scope: environment
Prevent database version changes
name
required: true
scope: environment
Name of the environment
network_id
required: false
scope: environment
Network ID to associate with this environment
region
required: false
scope: environment
Region for the environment
snapshot_limit
required: false
scope: environment
Number of snapshots to keep
snapshot_retention
required: false
scope: environment
Number of days to keep the snapshots
takeover_preference
required: false
scope: environment
default: snapshot
How to handle takeovers. Valid values: [snapshot, new_volume, no_slave, disable]

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "environment": {
              "name": "d2297602",
              "application_id": 24,
              "encrypted_ebs_for_everything": true
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environment": {
              "id": 8,
              "account": "https://api.engineyard.com/accounts/9f7613b3-04fd-495a-abb7-cabae6fc7225",
              "alerts": "https://api.engineyard.com/environments/8/server-alerts",
              "applications": "https://api.engineyard.com/environments/8/applications",
              "classic": true,
              "created_at": "2017-10-10T15:37:38+00:00",
              "database_services": "https://api.engineyard.com/environments/8/database-services",
              "deleted_at": null,
              "firewall": null,
              "internal_private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEoAIBAAKCAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGw\nL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0\nmAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KK\nP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWV\neLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93\nKFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCewwIBIwKCAQB+0sLxaiayUX9G4oAF\nPwc6Z39n5kugk4EAVYSDzhhyIkeox/dv6oBbgMrTV4VW7QXjTH4J6UGCbZvlFZPu\n0voG/LyIAWLPb956mY0iYm8HEOtnjllrOhUZqtYmbrohOGhvlhH8mGlCSYejfjnO\nUHu5h38AXfRsr9EyYhCQl+pyhHeDZwM0MQm5459XTmoSjW7AcFaE4qn0CD0VGeQ9\nDlbH2zCcQU3+Ljpvla+ME5yN3qeppKd/bQQp3FT7MpxdDcEGDHtnkAEhggbRcXJ+\nrBw5F8GN2j8f5jZdflnb8FHVI+iAiTLfBc74V1+z5n+XnkwbtagjQpU1MpyeKp5R\nPGPTAoGBAORa/BsN7zYqw0wsCSQv3kpkGjZNnVO8PUxThVddpLJiDZI1xyWOPCrW\nlwdk8cPC2uNwc83HY/u3qMARLwfcOQdNWtvjZWwYjWjulh2b884FFVgMopPGKPpc\nNzNxdsXRajEWbw8eK8Sv6j/qF9wpMMwCFB8h0pMBorJo8V65zPktAoGBANha/+/h\n5pmkJ49kmbwyCPUBt3Z/vB6+SlsBIOcN9gWJYoaNbWeJIehMcJaoNtVArYwKIEM9\nUPhySPxmXXzPO0ux0igNA77CbOzFjR05EbGB5rRbKNd92fw8KV/tWucTPthRV/k8\nWPWOJhfIFj3MOVjopaHUqFvimlvXhuAwlw2vAoGAVNFWUzEPtQiRrpQDZTZZ4R3d\n2afMuLOhvUOX7UAJ+R0a+8rU8LEsSmz2RJM1OhUsuuCgCpqEOOxx4PBwjeQVLpkT\nHnkIafp9qqHCuoph3s6wKASxahZm/ee8u1YHi03IW2AanzcXkjK2F71ZUcYoEUKZ\nwmul/BaM4y5LBe09gR8CgYA3ol8RzF/eXWlCIS7Ynybf6n+iINiaMO6MbgEleJ5Z\nMfTDg3PnbGfOBQcCK0FMx30VYbCGUZh6ZofL387llF+0YOzlujQpvPdwFYqvvje/\n7jQCfddNWuBILLounB6wcqnCmJL28kLCzMf3fJgBQySwdlZ6Ehyp6c/ruxQNw1oK\n1QKBgDDNm9MBRY8OTKCQKj9HJx7Gh3zFKHIIBAjZlEdcwgzjsNi8+HsQuDiTkroe\nxhXjGNCek0vwr81HAa0wbEFPF1ohxkICUavo10SAMeLZQGRGhYV6oxCpD415oZI2\n0sZlQjRBG6S4zkBIk9R7+RMz3YGpey/SnNFWhhrBKBMPU0VW\n-----END RSA PRIVATE KEY-----",
              "internal_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGwL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0mAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KKP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWVeLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93KFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCeww==",
              "keypairs": "https://api.engineyard.com/environments/8/keypairs",
              "logical_databases": "https://api.engineyard.com/environments/8/logical-databases",
              "monitor_url": null,
              "name": "d2297602",
              "server_alerts": "https://api.engineyard.com/environments/8/server-alerts",
              "servers": "https://api.engineyard.com/environments/8/servers",
              "service_level": "default",
              "service_plan": null,
              "snapshots": "https://api.engineyard.com/environments/8/snapshots",
              "updated_at": "2017-10-10T15:37:38+00:00",
              "auto_scaling_group": null,
              "available_upgrade_web_uri": null,
              "custom_recipes": null,
              "database_backup_interval": 24,
              "database_backup_limit": 10,
              "database_stack": "postgres9_4",
              "deploy_method": "serverside",
              "deployments": "https://api.engineyard.com/environments/8/deployments",
              "encrypted_database_ebs": false,
              "encrypted_ebs_for_everything": true,
              "framework_env": "production",
              "kubey_cluster": "https://api.engineyard.com/environments/8/kubey_cluster",
              "kubey_logical_database_count": null,
              "kubey_master_count": 0,
              "kubey_node_count": 0,
              "language": "Ruby 2.2",
              "lock_db_version": true,
              "network": null,
              "region": "us-east-1",
              "release_label": "stable-v4-2.0.107",
              "requests": "https://api.engineyard.com/environments/8/requests",
              "snapshot_limit": 10,
              "snapshot_retention": 90,
              "stack_name": "nginx_passenger4",
              "takeover_preference": "snapshot",
              "upgrade_available": false,
              "username": "deploy",
              "vpc_name": null,
              "vpc_provisioned_id": null
            }
          }
            
          








Delete an environment

DELETE /environments/:environment

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "destroy_environment",
              "id": "b3b98c51-48cb-44f9-81d7-26b1afaceb0c",
              "created_at": "2017-10-10T15:40:41+00:00",
              "started_at": "2017-10-10T15:40:41+00:00",
              "finished_at": "2017-10-10T15:40:49+00:00",
              "message": null,
              "request_status": "Finished: Destroy environment (b3b98c51-48cb-44f9-81d7-26b1afaceb0c) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:40:49+00:00",
              "read_channel": null,
              "stage": "cleanup",
              "dependencies": "https://api.engineyard.com/requests/b3b98c51-48cb-44f9-81d7-26b1afaceb0c/dependencies",
              "stages": "https://api.engineyard.com/requests/b3b98c51-48cb-44f9-81d7-26b1afaceb0c/stages",
              "account": "https://api.engineyard.com/accounts/6e0555c1-c14a-472a-bb20-db5c432eda36",
              "requester": "https://api.engineyard.com/requests/b3b98c51-48cb-44f9-81d7-26b1afaceb0c/requester",
              "messages": "https://api.engineyard.com/requests/b3b98c51-48cb-44f9-81d7-26b1afaceb0c/messages",
              "callback_url": "https://api.engineyard.com/requests/b3b98c51-48cb-44f9-81d7-26b1afaceb0c/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/22"
            }
          }
            
          








Deploy an application to an environment

POST /environments/:environment/deploy

Parameters

application_id
required: true
Id of the application to deploy
deploy
required: true
Hash of deployment options
ref
required: true
scope: deploy
Ref to deploy (HEAD, master, branch, etc)
migrate
required: false
scope: deploy
Boolean whether or not to migrate the database
migrate_command
required: false
scope: deploy
Command to run during the migration

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "application_id": 39,
            "deploy": {
              "ref": "HEAD",
              "migrate": true,
              "migration_command": "bundle exec rake db:migrate"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "app_deployment",
              "id": "df94545c-fe13-4cbe-a6b4-37e4413218c9",
              "created_at": "2017-10-10T15:41:04+00:00",
              "started_at": "2017-10-10T15:41:04+00:00",
              "finished_at": "2017-10-10T15:41:04+00:00",
              "message": null,
              "request_status": "Finished: App deployment (df94545c-fe13-4cbe-a6b4-37e4413218c9) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:41:04+00:00",
              "read_channel": "https://messages.engineyard.com/stream?subscription=%2Frequests%2Fdf94545c&token=2e63efa340fd9238e4c3a28ee12c25f8",
              "stage": "deploy",
              "dependencies": "https://api.engineyard.com/requests/df94545c-fe13-4cbe-a6b4-37e4413218c9/dependencies",
              "stages": "https://api.engineyard.com/requests/df94545c-fe13-4cbe-a6b4-37e4413218c9/stages",
              "account": "https://api.engineyard.com/accounts/8827cfb9-bd69-4d51-81a6-ae805614bbec",
              "requester": "https://api.engineyard.com/requests/df94545c-fe13-4cbe-a6b4-37e4413218c9/requester",
              "messages": "https://api.engineyard.com/requests/df94545c-fe13-4cbe-a6b4-37e4413218c9/messages",
              "callback_url": "https://api.engineyard.com/requests/df94545c-fe13-4cbe-a6b4-37e4413218c9/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/deployments/9"
            }
          }
            
          








Disable maintenance on an application in an environment

PUT /environments/:environment/maintenance

Parameters

application_id
required: true
Id of the application to deploy
maintenance
required: true
Hash of maintenance options
action
required: true
scope: maintenance
Enable/Disable maintenance

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "application_id": 42,
            "maintenance": {
              "action": "disable"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "app_deployment_maintenance",
              "id": "eadeb168-b7bf-464c-b6d9-df64ea7d0014",
              "created_at": "2017-10-10T15:41:48+00:00",
              "started_at": "2017-10-10T15:41:48+00:00",
              "finished_at": "2017-10-10T15:41:48+00:00",
              "message": null,
              "request_status": "Finished: App deployment maintenance (eadeb168-b7bf-464c-b6d9-df64ea7d0014) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:41:48+00:00",
              "read_channel": null,
              "stage": "set_maintenance",
              "dependencies": "https://api.engineyard.com/requests/eadeb168-b7bf-464c-b6d9-df64ea7d0014/dependencies",
              "stages": "https://api.engineyard.com/requests/eadeb168-b7bf-464c-b6d9-df64ea7d0014/stages",
              "account": "https://api.engineyard.com/accounts/6d31daa6-a894-4f82-9d18-f7d74843e74c",
              "requester": "https://api.engineyard.com/requests/eadeb168-b7bf-464c-b6d9-df64ea7d0014/requester",
              "messages": "https://api.engineyard.com/requests/eadeb168-b7bf-464c-b6d9-df64ea7d0014/messages",
              "callback_url": "https://api.engineyard.com/requests/eadeb168-b7bf-464c-b6d9-df64ea7d0014/callback",
              "progress": false,
              "resource": false
            }
          }
            
          








Enable maintenance on an application in an environment

PUT /environments/:environment/maintenance

Parameters

application_id
required: true
Id of the application to deploy
maintenance
required: true
Hash of maintenance options
action
required: true
scope: maintenance
Enable/Disable maintenance

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "application_id": 41,
            "maintenance": {
              "action": "enable"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "app_deployment_maintenance",
              "id": "f0eb8233-9ed1-4949-9a87-73ec5cbc7518",
              "created_at": "2017-10-10T15:41:33+00:00",
              "started_at": "2017-10-10T15:41:33+00:00",
              "finished_at": "2017-10-10T15:41:34+00:00",
              "message": null,
              "request_status": "Finished: App deployment maintenance (f0eb8233-9ed1-4949-9a87-73ec5cbc7518) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:41:34+00:00",
              "read_channel": null,
              "stage": "set_maintenance",
              "dependencies": "https://api.engineyard.com/requests/f0eb8233-9ed1-4949-9a87-73ec5cbc7518/dependencies",
              "stages": "https://api.engineyard.com/requests/f0eb8233-9ed1-4949-9a87-73ec5cbc7518/stages",
              "account": "https://api.engineyard.com/accounts/91549a32-e3d8-4445-8a83-1e80aacdc91b",
              "requester": "https://api.engineyard.com/requests/f0eb8233-9ed1-4949-9a87-73ec5cbc7518/requester",
              "messages": "https://api.engineyard.com/requests/f0eb8233-9ed1-4949-9a87-73ec5cbc7518/messages",
              "callback_url": "https://api.engineyard.com/requests/f0eb8233-9ed1-4949-9a87-73ec5cbc7518/callback",
              "progress": false,
              "resource": false
            }
          }
            
          








List environments

GET /environments

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environments": [
              {
                "id": 12,
                "account": "https://api.engineyard.com/accounts/7265f89f-217e-4b1a-8e26-2f0f2a6a1063",
                "alerts": "https://api.engineyard.com/environments/12/server-alerts",
                "applications": "https://api.engineyard.com/environments/12/applications",
                "classic": true,
                "created_at": "2017-10-10T15:37:51+00:00",
                "database_services": "https://api.engineyard.com/environments/12/database-services",
                "deleted_at": null,
                "firewall": null,
                "internal_private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEoAIBAAKCAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGw\nL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0\nmAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KK\nP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWV\neLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93\nKFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCewwIBIwKCAQB+0sLxaiayUX9G4oAF\nPwc6Z39n5kugk4EAVYSDzhhyIkeox/dv6oBbgMrTV4VW7QXjTH4J6UGCbZvlFZPu\n0voG/LyIAWLPb956mY0iYm8HEOtnjllrOhUZqtYmbrohOGhvlhH8mGlCSYejfjnO\nUHu5h38AXfRsr9EyYhCQl+pyhHeDZwM0MQm5459XTmoSjW7AcFaE4qn0CD0VGeQ9\nDlbH2zCcQU3+Ljpvla+ME5yN3qeppKd/bQQp3FT7MpxdDcEGDHtnkAEhggbRcXJ+\nrBw5F8GN2j8f5jZdflnb8FHVI+iAiTLfBc74V1+z5n+XnkwbtagjQpU1MpyeKp5R\nPGPTAoGBAORa/BsN7zYqw0wsCSQv3kpkGjZNnVO8PUxThVddpLJiDZI1xyWOPCrW\nlwdk8cPC2uNwc83HY/u3qMARLwfcOQdNWtvjZWwYjWjulh2b884FFVgMopPGKPpc\nNzNxdsXRajEWbw8eK8Sv6j/qF9wpMMwCFB8h0pMBorJo8V65zPktAoGBANha/+/h\n5pmkJ49kmbwyCPUBt3Z/vB6+SlsBIOcN9gWJYoaNbWeJIehMcJaoNtVArYwKIEM9\nUPhySPxmXXzPO0ux0igNA77CbOzFjR05EbGB5rRbKNd92fw8KV/tWucTPthRV/k8\nWPWOJhfIFj3MOVjopaHUqFvimlvXhuAwlw2vAoGAVNFWUzEPtQiRrpQDZTZZ4R3d\n2afMuLOhvUOX7UAJ+R0a+8rU8LEsSmz2RJM1OhUsuuCgCpqEOOxx4PBwjeQVLpkT\nHnkIafp9qqHCuoph3s6wKASxahZm/ee8u1YHi03IW2AanzcXkjK2F71ZUcYoEUKZ\nwmul/BaM4y5LBe09gR8CgYA3ol8RzF/eXWlCIS7Ynybf6n+iINiaMO6MbgEleJ5Z\nMfTDg3PnbGfOBQcCK0FMx30VYbCGUZh6ZofL387llF+0YOzlujQpvPdwFYqvvje/\n7jQCfddNWuBILLounB6wcqnCmJL28kLCzMf3fJgBQySwdlZ6Ehyp6c/ruxQNw1oK\n1QKBgDDNm9MBRY8OTKCQKj9HJx7Gh3zFKHIIBAjZlEdcwgzjsNi8+HsQuDiTkroe\nxhXjGNCek0vwr81HAa0wbEFPF1ohxkICUavo10SAMeLZQGRGhYV6oxCpD415oZI2\n0sZlQjRBG6S4zkBIk9R7+RMz3YGpey/SnNFWhhrBKBMPU0VW\n-----END RSA PRIVATE KEY-----",
                "internal_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAwP3xABDWtk9+5k2LKV/pm6igfLd+NyM+vbnJpy5+PmCv1FGwL99I5EmNsOlbmooUFxtbn8cg595yy+kvB0ENLAYqBp3vaC/M/Vj4KTGd0xm/RIq0mAp5Jw8ZW+AmXxMOOoAxocaJ6m/kquF5W1kVUfq2IfMmCZEc86Bb/Wy9z6ntA4KKP0HTenzkTSVVRnuwR+DMSac9c3LMoUgULLCJ4+orFSifmin8wbO/cwOoo8T/UDWVeLPkPR+h9c5ne9cq0Lpx0MneqctU8tr/UwBGTStUVesC+h6A+iDZVHcIB5zlpc93KFXqEQSbauXnQE/mpZaJLCMJmV2NR2sv1VCeww==",
                "keypairs": "https://api.engineyard.com/environments/12/keypairs",
                "logical_databases": "https://api.engineyard.com/environments/12/logical-databases",
                "monitor_url": null,
                "name": "332834",
                "server_alerts": "https://api.engineyard.com/environments/12/server-alerts",
                "servers": "https://api.engineyard.com/environments/12/servers",
                "service_level": "default",
                "service_plan": null,
                "snapshots": "https://api.engineyard.com/environments/12/snapshots",
                "updated_at": "2017-10-10T15:37:51+00:00",
                "auto_scaling_group": null,
                "available_upgrade_web_uri": null,
                "custom_recipes": null,
                "database_backup_interval": 24,
                "database_backup_limit": 10,
                "database_stack": "postgres9_4",
                "deploy_method": "serverside",
                "deployments": "https://api.engineyard.com/environments/12/deployments",
                "encrypted_database_ebs": false,
                "encrypted_ebs_for_everything": false,
                "framework_env": "production",
                "kubey_cluster": "https://api.engineyard.com/environments/12/kubey_cluster",
                "kubey_logical_database_count": null,
                "kubey_master_count": 0,
                "kubey_node_count": 0,
                "language": "Ruby 2.2",
                "lock_db_version": true,
                "network": null,
                "region": "us-east-2",
                "release_label": "stable-v4-2.0.107",
                "requests": "https://api.engineyard.com/environments/12/requests",
                "snapshot_limit": 10,
                "snapshot_retention": 90,
                "stack_name": "nginx_passenger4",
                "takeover_preference": "snapshot",
                "upgrade_available": false,
                "username": "deploy",
                "vpc_name": null,
                "vpc_provisioned_id": null
              }
            ]
          }
            
          








Restart app servers (unicorn, puma, etc)

PUT /environments/:environment/app_restart

Parameters

application_id
required: true
Id of the application to deploy

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "application_id": 43
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "app_server_restart",
              "id": "cf7c2c5d-5434-4a88-b956-83553d092931",
              "created_at": "2017-10-10T15:42:02+00:00",
              "started_at": "2017-10-10T15:42:02+00:00",
              "finished_at": "2017-10-10T15:42:03+00:00",
              "message": null,
              "request_status": "Finished: App server restart (cf7c2c5d-5434-4a88-b956-83553d092931) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:42:03+00:00",
              "read_channel": null,
              "stage": "restart-app-servers",
              "dependencies": "https://api.engineyard.com/requests/cf7c2c5d-5434-4a88-b956-83553d092931/dependencies",
              "stages": "https://api.engineyard.com/requests/cf7c2c5d-5434-4a88-b956-83553d092931/stages",
              "account": "https://api.engineyard.com/accounts/6c93b992-453f-43d6-9616-0787be6243c3",
              "requester": "https://api.engineyard.com/requests/cf7c2c5d-5434-4a88-b956-83553d092931/requester",
              "messages": "https://api.engineyard.com/requests/cf7c2c5d-5434-4a88-b956-83553d092931/messages",
              "callback_url": "https://api.engineyard.com/requests/cf7c2c5d-5434-4a88-b956-83553d092931/callback",
              "progress": false,
              "resource": false
            }
          }
            
          








Run chef on an environment

POST /environments/:environment/apply

Parameters

type
required: false
Type of chef run (main, custom, quick)

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "configure_environment",
              "id": "fb1e51fe-af0d-457e-b0df-b27db63f549a",
              "created_at": "2017-10-10T15:41:18+00:00",
              "started_at": "2017-10-10T15:41:18+00:00",
              "finished_at": "2017-10-10T15:41:19+00:00",
              "message": null,
              "request_status": "Finished: Configure environment (fb1e51fe-af0d-457e-b0df-b27db63f549a) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:41:19+00:00",
              "read_channel": null,
              "stage": "environment.update-instances",
              "dependencies": "https://api.engineyard.com/requests/fb1e51fe-af0d-457e-b0df-b27db63f549a/dependencies",
              "stages": "https://api.engineyard.com/requests/fb1e51fe-af0d-457e-b0df-b27db63f549a/stages",
              "account": "https://api.engineyard.com/accounts/e05cdaf5-cce3-4c25-80b4-dc4371068970",
              "requester": "https://api.engineyard.com/requests/fb1e51fe-af0d-457e-b0df-b27db63f549a/requester",
              "messages": "https://api.engineyard.com/requests/fb1e51fe-af0d-457e-b0df-b27db63f549a/messages",
              "callback_url": "https://api.engineyard.com/requests/fb1e51fe-af0d-457e-b0df-b27db63f549a/callback",
              "progress": false,
              "resource": false
            }
          }
            
          








Save a blueprint of an environment

POST /environments/:environment/blueprint

Parameters

name
required: true
Name of the blueprint

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "name": "d3c6b6"
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "blueprint": {
              "id": "7772922c-9902-441a-ae27-483bc8f798ca",
              "account": "https://api.engineyard.com/accounts/6a58dbee-d726-4942-90c6-53e7bf917c22",
              "environment": "https://api.engineyard.com/environments/20",
              "created_at": "2017-10-10T15:40:04+00:00",
              "updated_at": "2017-10-10T15:40:04+00:00",
              "data": {
                "app_instances": [
                  {
                    "encrypted": false,
                    "flavor": "m4_large",
                    "mnt_volume_size": 25,
                    "name": null,
                    "volume_iops": null,
                    "volume_size": 15
                  }
                ],
                "db_master": [
          
                ],
                "db_slaves": [
          
                ],
                "utils": [
          
                ]
              },
              "name": "d3c6b6"
            }
          }
            
          








Stop an environment

PUT /environments/:environment/deprovision

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "deprovision_environment",
              "id": "29b2fd8b-1c33-4d03-9c9f-3733b57e5321",
              "created_at": "2017-10-10T15:40:18+00:00",
              "started_at": "2017-10-10T15:40:18+00:00",
              "finished_at": "2017-10-10T15:40:25+00:00",
              "message": null,
              "request_status": "Finished: Deprovision environment (29b2fd8b-1c33-4d03-9c9f-3733b57e5321) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:40:25+00:00",
              "read_channel": null,
              "stage": "notify",
              "dependencies": "https://api.engineyard.com/requests/29b2fd8b-1c33-4d03-9c9f-3733b57e5321/dependencies",
              "stages": "https://api.engineyard.com/requests/29b2fd8b-1c33-4d03-9c9f-3733b57e5321/stages",
              "account": "https://api.engineyard.com/accounts/4e0c948b-2fdb-44b5-a10b-7303aba4a5f0",
              "requester": "https://api.engineyard.com/requests/29b2fd8b-1c33-4d03-9c9f-3733b57e5321/requester",
              "messages": "https://api.engineyard.com/requests/29b2fd8b-1c33-4d03-9c9f-3733b57e5321/messages",
              "callback_url": "https://api.engineyard.com/requests/29b2fd8b-1c33-4d03-9c9f-3733b57e5321/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/21"
            }
          }