Environments API


Stop an environment

PUT /environments/:environment/deprovision

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "deprovision_environment",
              "id": "93a78902-ef1e-4dd1-886f-cd72b07e64fc",
              "created_at": "2017-02-22T17:06:08+00:00",
              "started_at": "2017-02-22T17:06:08+00:00",
              "finished_at": "2017-02-22T17:06:14+00:00",
              "message": null,
              "request_status": "Finished: Deprovision environment (93a78902-ef1e-4dd1-886f-cd72b07e64fc) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:06:14+00:00",
              "read_channel": null,
              "stage": "notify",
              "dependencies": "https://api.engineyard.com/requests/93a78902-ef1e-4dd1-886f-cd72b07e64fc/dependencies",
              "stages": "https://api.engineyard.com/requests/93a78902-ef1e-4dd1-886f-cd72b07e64fc/stages",
              "account": "https://api.engineyard.com/accounts/b4225c08-13c6-4c1f-9654-8a4f45a4cdc9",
              "requester": "https://api.engineyard.com/requests/93a78902-ef1e-4dd1-886f-cd72b07e64fc/requester",
              "messages": "https://api.engineyard.com/requests/93a78902-ef1e-4dd1-886f-cd72b07e64fc/messages",
              "callback_url": "https://api.engineyard.com/requests/93a78902-ef1e-4dd1-886f-cd72b07e64fc/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/15"
            }
          }
            
          








Create an environment with a custom database stack

POST /accounts/:account/environments

Parameters

account
required: false
Account to assign the environment to
name
required: true
scope: environment
Name of the environment
application_id
required: true
scope: environment
Id of the application to associate with this environment
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
deploy_method
required: false
scope: environment
default: serverside
Default deployment method for the environment. Valid values are chef, serverside, none
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", "no_db"]
region
required: false
scope: environment
Region for the environment
network_id
required: false
scope: environment
Network ID to associate with this environment

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "environment": {
              "name": "35db5ff6",
              "application_id": 4,
              "database_stack": "postgres9_3"
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environment": {
              "id": 4,
              "account": "https://api.engineyard.com/accounts/8824f00d-72a1-415f-96e7-f682c78c8bea",
              "alerts": "https://api.engineyard.com/environments/4/server-alerts",
              "applications": "https://api.engineyard.com/environments/4/applications",
              "classic": true,
              "created_at": "2017-02-22T17:02:18+00:00",
              "database_services": "https://api.engineyard.com/environments/4/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/4/keypairs",
              "logical_databases": "https://api.engineyard.com/environments/4/logical-databases",
              "monitor_url": null,
              "name": "35db5ff6",
              "server_alerts": "https://api.engineyard.com/environments/4/server-alerts",
              "servers": "https://api.engineyard.com/environments/4/servers",
              "service_level": "default",
              "service_plan": null,
              "snapshots": "https://api.engineyard.com/environments/4/snapshots",
              "updated_at": "2017-02-22T17:02:18+00:00",
              "custom_recipes": null,
              "database_stack": "postgres9_3",
              "deploy_method": "serverside",
              "deployments": "https://api.engineyard.com/environments/4/deployments",
              "framework_env": "production",
              "kubey_cluster": "https://api.engineyard.com/environments/4/kubey_cluster",
              "language": "Ruby 2.2",
              "network": null,
              "region": "us-east-1",
              "release_label": "stable-v4-2.0.107",
              "requests": "https://api.engineyard.com/environments/4/requests",
              "stack_name": "nginx_passenger4",
              "username": "deploy"
            }
          }
            
          








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": "646e9a85-2e1c-410b-9b50-b9dc825a8020",
              "created_at": "2017-02-22T17:03:50+00:00",
              "started_at": "2017-02-22T17:03:50+00:00",
              "finished_at": "2017-02-22T17:04:07+00:00",
              "message": null,
              "request_status": "Finished: Start environment (646e9a85-2e1c-410b-9b50-b9dc825a8020) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:04:07+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/646e9a85-2e1c-410b-9b50-b9dc825a8020/dependencies",
              "stages": "https://api.engineyard.com/requests/646e9a85-2e1c-410b-9b50-b9dc825a8020/stages",
              "account": "https://api.engineyard.com/accounts/28888e7a-595b-42c3-83ff-35b0d17809a4",
              "requester": "https://api.engineyard.com/requests/646e9a85-2e1c-410b-9b50-b9dc825a8020/requester",
              "messages": "https://api.engineyard.com/requests/646e9a85-2e1c-410b-9b50-b9dc825a8020/messages",
              "callback_url": "https://api.engineyard.com/requests/646e9a85-2e1c-410b-9b50-b9dc825a8020/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/10"
            }
          }
            
          








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": "bbaf3c0e-5f8b-401a-8b71-1a49011bc7f3"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "start_environment",
              "id": "9e83ee68-d884-49ba-9607-f5a488485636",
              "created_at": "2017-02-22T17:02:45+00:00",
              "started_at": "2017-02-22T17:02:45+00:00",
              "finished_at": "2017-02-22T17:03:00+00:00",
              "message": null,
              "request_status": "Finished: Start environment (9e83ee68-d884-49ba-9607-f5a488485636) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:03:00+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/9e83ee68-d884-49ba-9607-f5a488485636/dependencies",
              "stages": "https://api.engineyard.com/requests/9e83ee68-d884-49ba-9607-f5a488485636/stages",
              "account": "https://api.engineyard.com/accounts/564ab983-0041-4d19-b1dc-7d866cd70bcc",
              "requester": "https://api.engineyard.com/requests/9e83ee68-d884-49ba-9607-f5a488485636/requester",
              "messages": "https://api.engineyard.com/requests/9e83ee68-d884-49ba-9607-f5a488485636/messages",
              "callback_url": "https://api.engineyard.com/requests/9e83ee68-d884-49ba-9607-f5a488485636/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/7"
            }
          }
            
          








Create an environment with a custom language

POST /accounts/:account/environments

Parameters

account
required: false
Account to assign the environment to
name
required: true
scope: environment
Name of the environment
application_id
required: true
scope: environment
Id of the application to associate with this environment
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
deploy_method
required: false
scope: environment
default: serverside
Default deployment method for the environment. Valid values are chef, serverside, none
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", "no_db"]
region
required: false
scope: environment
Region for the environment
network_id
required: false
scope: environment
Network ID to associate with this environment

Request

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

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environment": {
              "id": 3,
              "account": "https://api.engineyard.com/accounts/20c03916-a374-4576-8bd3-beba161f3a38",
              "alerts": "https://api.engineyard.com/environments/3/server-alerts",
              "applications": "https://api.engineyard.com/environments/3/applications",
              "classic": true,
              "created_at": "2017-02-22T17:02:10+00:00",
              "database_services": "https://api.engineyard.com/environments/3/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/3/keypairs",
              "logical_databases": "https://api.engineyard.com/environments/3/logical-databases",
              "monitor_url": null,
              "name": "656acff3",
              "server_alerts": "https://api.engineyard.com/environments/3/server-alerts",
              "servers": "https://api.engineyard.com/environments/3/servers",
              "service_level": "default",
              "service_plan": null,
              "snapshots": "https://api.engineyard.com/environments/3/snapshots",
              "updated_at": "2017-02-22T17:02:10+00:00",
              "custom_recipes": null,
              "database_stack": "postgres9_4",
              "deploy_method": "serverside",
              "deployments": "https://api.engineyard.com/environments/3/deployments",
              "framework_env": "production",
              "kubey_cluster": "https://api.engineyard.com/environments/3/kubey_cluster",
              "language": "Ruby 2.1.5",
              "network": null,
              "region": "us-east-1",
              "release_label": "stable-v4-2.0.107",
              "requests": "https://api.engineyard.com/environments/3/requests",
              "stack_name": "nginx_passenger4",
              "username": "deploy"
            }
          }
            
          








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": 20,
            "maintenance": {
              "action": "disable"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "app_deployment_maintenance",
              "id": "c583b0c7-0a72-4dc9-a5c8-c7aa3dfef111",
              "created_at": "2017-02-22T17:07:55+00:00",
              "started_at": "2017-02-22T17:07:55+00:00",
              "finished_at": "2017-02-22T17:07:55+00:00",
              "message": null,
              "request_status": "Finished: App deployment maintenance (c583b0c7-0a72-4dc9-a5c8-c7aa3dfef111) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:07:55+00:00",
              "read_channel": null,
              "stage": "set_maintenance",
              "dependencies": "https://api.engineyard.com/requests/c583b0c7-0a72-4dc9-a5c8-c7aa3dfef111/dependencies",
              "stages": "https://api.engineyard.com/requests/c583b0c7-0a72-4dc9-a5c8-c7aa3dfef111/stages",
              "account": "https://api.engineyard.com/accounts/209b07a0-35e4-4e46-9d99-600f660562ac",
              "requester": "https://api.engineyard.com/requests/c583b0c7-0a72-4dc9-a5c8-c7aa3dfef111/requester",
              "messages": "https://api.engineyard.com/requests/c583b0c7-0a72-4dc9-a5c8-c7aa3dfef111/messages",
              "callback_url": "https://api.engineyard.com/requests/c583b0c7-0a72-4dc9-a5c8-c7aa3dfef111/callback",
              "progress": false,
              "resource": false
            }
          }
            
          








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": "19f2ca54-a66c-4f18-bfd5-9aaff296ace5",
              "created_at": "2017-02-22T17:03:31+00:00",
              "started_at": "2017-02-22T17:03:32+00:00",
              "finished_at": "2017-02-22T17:03:41+00:00",
              "message": null,
              "request_status": "Finished: Start environment (19f2ca54-a66c-4f18-bfd5-9aaff296ace5) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:03:41+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/19f2ca54-a66c-4f18-bfd5-9aaff296ace5/dependencies",
              "stages": "https://api.engineyard.com/requests/19f2ca54-a66c-4f18-bfd5-9aaff296ace5/stages",
              "account": "https://api.engineyard.com/accounts/8980071d-7e46-4d37-baa2-76ff188a264e",
              "requester": "https://api.engineyard.com/requests/19f2ca54-a66c-4f18-bfd5-9aaff296ace5/requester",
              "messages": "https://api.engineyard.com/requests/19f2ca54-a66c-4f18-bfd5-9aaff296ace5/messages",
              "callback_url": "https://api.engineyard.com/requests/19f2ca54-a66c-4f18-bfd5-9aaff296ace5/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/9"
            }
          }
            
          








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": "e85e67ff-5b78-4ba5-88f1-d55b21515f1b",
              "ip_id": 2
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "start_environment",
              "id": "880a879b-dcce-4380-b746-a80bd5d6f52a",
              "created_at": "2017-02-22T17:03:09+00:00",
              "started_at": "2017-02-22T17:03:09+00:00",
              "finished_at": "2017-02-22T17:03:23+00:00",
              "message": null,
              "request_status": "Finished: Start environment (880a879b-dcce-4380-b746-a80bd5d6f52a) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:03:23+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/880a879b-dcce-4380-b746-a80bd5d6f52a/dependencies",
              "stages": "https://api.engineyard.com/requests/880a879b-dcce-4380-b746-a80bd5d6f52a/stages",
              "account": "https://api.engineyard.com/accounts/e6a6f952-5864-4dc2-81b1-5e905b887454",
              "requester": "https://api.engineyard.com/requests/880a879b-dcce-4380-b746-a80bd5d6f52a/requester",
              "messages": "https://api.engineyard.com/requests/880a879b-dcce-4380-b746-a80bd5d6f52a/messages",
              "callback_url": "https://api.engineyard.com/requests/880a879b-dcce-4380-b746-a80bd5d6f52a/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/8"
            }
          }
            
          








Create an environment

POST /accounts/:account/environments

Parameters

account
required: false
Account to assign the environment to
name
required: true
scope: environment
Name of the environment
application_id
required: true
scope: environment
Id of the application to associate with this environment
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
deploy_method
required: false
scope: environment
default: serverside
Default deployment method for the environment. Valid values are chef, serverside, none
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", "no_db"]
region
required: false
scope: environment
Region for the environment
network_id
required: false
scope: environment
Network ID to associate with this environment

Request

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

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environment": {
              "id": 1,
              "account": "https://api.engineyard.com/accounts/1fe26ad9-1fba-4287-978d-4ad02b5eb4f9",
              "alerts": "https://api.engineyard.com/environments/1/server-alerts",
              "applications": "https://api.engineyard.com/environments/1/applications",
              "classic": true,
              "created_at": "2017-02-22T17:01:56+00:00",
              "database_services": "https://api.engineyard.com/environments/1/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/1/keypairs",
              "logical_databases": "https://api.engineyard.com/environments/1/logical-databases",
              "monitor_url": null,
              "name": "newenvironment",
              "server_alerts": "https://api.engineyard.com/environments/1/server-alerts",
              "servers": "https://api.engineyard.com/environments/1/servers",
              "service_level": "default",
              "service_plan": null,
              "snapshots": "https://api.engineyard.com/environments/1/snapshots",
              "updated_at": "2017-02-22T17:01:56+00:00",
              "custom_recipes": null,
              "database_stack": "postgres9_4",
              "deploy_method": "serverside",
              "deployments": "https://api.engineyard.com/environments/1/deployments",
              "framework_env": "production",
              "kubey_cluster": "https://api.engineyard.com/environments/1/kubey_cluster",
              "language": "Ruby 2.2",
              "network": null,
              "region": "us-east-1",
              "release_label": "stable-v4-2.0.107",
              "requests": "https://api.engineyard.com/environments/1/requests",
              "stack_name": "nginx_passenger4",
              "username": "deploy"
            }
          }
            
          








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": "2a8cbb8a-2109-4034-8724-be8a3966ff18",
              "created_at": "2017-02-22T17:05:17+00:00",
              "started_at": "2017-02-22T17:05:17+00:00",
              "finished_at": "2017-02-22T17:05:31+00:00",
              "message": null,
              "request_status": "Finished: Start environment (2a8cbb8a-2109-4034-8724-be8a3966ff18) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:05:31+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/2a8cbb8a-2109-4034-8724-be8a3966ff18/dependencies",
              "stages": "https://api.engineyard.com/requests/2a8cbb8a-2109-4034-8724-be8a3966ff18/stages",
              "account": "https://api.engineyard.com/accounts/a8883415-515f-4d8d-9384-fe72e894dfd8",
              "requester": "https://api.engineyard.com/requests/2a8cbb8a-2109-4034-8724-be8a3966ff18/requester",
              "messages": "https://api.engineyard.com/requests/2a8cbb8a-2109-4034-8724-be8a3966ff18/messages",
              "callback_url": "https://api.engineyard.com/requests/2a8cbb8a-2109-4034-8724-be8a3966ff18/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/13"
            }
          }
            
          








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": "a4cce0"
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "blueprint": {
              "id": "bff4be1b-208a-4363-83c3-c4361ab0c95a",
              "account": "https://api.engineyard.com/accounts/09c07a77-c8b0-466c-aa4f-0f053184eef4",
              "environment": "https://api.engineyard.com/environments/14",
              "created_at": "2017-02-22T17:05:50+00:00",
              "updated_at": "2017-02-22T17:05:50+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": "a4cce0"
            }
          }
            
          








Create an environment with a custom framework environment

POST /accounts/:account/environments

Parameters

account
required: false
Account to assign the environment to
name
required: true
scope: environment
Name of the environment
application_id
required: true
scope: environment
Id of the application to associate with this environment
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
deploy_method
required: false
scope: environment
default: serverside
Default deployment method for the environment. Valid values are chef, serverside, none
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", "no_db"]
region
required: false
scope: environment
Region for the environment
network_id
required: false
scope: environment
Network ID to associate with this environment

Request

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

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environment": {
              "id": 2,
              "account": "https://api.engineyard.com/accounts/39cef8b9-8ad1-4efe-820a-4d0d64b20350",
              "alerts": "https://api.engineyard.com/environments/2/server-alerts",
              "applications": "https://api.engineyard.com/environments/2/applications",
              "classic": true,
              "created_at": "2017-02-22T17:02:03+00:00",
              "database_services": "https://api.engineyard.com/environments/2/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/2/keypairs",
              "logical_databases": "https://api.engineyard.com/environments/2/logical-databases",
              "monitor_url": null,
              "name": "883b371d",
              "server_alerts": "https://api.engineyard.com/environments/2/server-alerts",
              "servers": "https://api.engineyard.com/environments/2/servers",
              "service_level": "default",
              "service_plan": null,
              "snapshots": "https://api.engineyard.com/environments/2/snapshots",
              "updated_at": "2017-02-22T17:02:03+00:00",
              "custom_recipes": null,
              "database_stack": "postgres9_4",
              "deploy_method": "serverside",
              "deployments": "https://api.engineyard.com/environments/2/deployments",
              "framework_env": "testing",
              "kubey_cluster": "https://api.engineyard.com/environments/2/kubey_cluster",
              "language": "Ruby 2.2",
              "network": null,
              "region": "us-east-1",
              "release_label": "stable-v4-2.0.107",
              "requests": "https://api.engineyard.com/environments/2/requests",
              "stack_name": "nginx_passenger4",
              "username": "deploy"
            }
          }
            
          








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": 17,
            "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": "39d027ec-bf06-434b-91d1-76eb581cb26b",
              "created_at": "2017-02-22T17:06:57+00:00",
              "started_at": "2017-02-22T17:06:57+00:00",
              "finished_at": "2017-02-22T17:06:57+00:00",
              "message": null,
              "request_status": "Finished: App deployment (39d027ec-bf06-434b-91d1-76eb581cb26b) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:06:57+00:00",
              "read_channel": "https://messages.engineyard.com/stream?subscription=%2Frequests%2F39d027ec&token=78f32c7d1545476f9af66eb160c12e9f",
              "stage": "deploy",
              "dependencies": "https://api.engineyard.com/requests/39d027ec-bf06-434b-91d1-76eb581cb26b/dependencies",
              "stages": "https://api.engineyard.com/requests/39d027ec-bf06-434b-91d1-76eb581cb26b/stages",
              "account": "https://api.engineyard.com/accounts/a91be754-b4c9-4803-9853-33e336d8b766",
              "requester": "https://api.engineyard.com/requests/39d027ec-bf06-434b-91d1-76eb581cb26b/requester",
              "messages": "https://api.engineyard.com/requests/39d027ec-bf06-434b-91d1-76eb581cb26b/messages",
              "callback_url": "https://api.engineyard.com/requests/39d027ec-bf06-434b-91d1-76eb581cb26b/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/deployments/11"
            }
          }
            
          








List environments

GET /environments

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environments": [
              {
                "id": 6,
                "account": "https://api.engineyard.com/accounts/29a2718f-58b2-460f-8626-3e7a5f9bdf42",
                "alerts": "https://api.engineyard.com/environments/6/server-alerts",
                "applications": "https://api.engineyard.com/environments/6/applications",
                "classic": true,
                "created_at": "2017-02-22T17:02:36+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": "3dde85",
                "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-02-22T17:02:36+00:00",
                "custom_recipes": null,
                "database_stack": "postgres9_4",
                "deploy_method": "serverside",
                "deployments": "https://api.engineyard.com/environments/6/deployments",
                "framework_env": "production",
                "kubey_cluster": "https://api.engineyard.com/environments/6/kubey_cluster",
                "language": "Ruby 2.2",
                "network": null,
                "region": "us-east-2",
                "release_label": "stable-v4-2.0.107",
                "requests": "https://api.engineyard.com/environments/6/requests",
                "stack_name": "nginx_passenger4",
                "username": "deploy"
              }
            ]
          }
            
          








Create an environment with an associated network

POST /accounts/:account/environments

Parameters

account
required: false
Account to assign the environment to
name
required: true
scope: environment
Name of the environment
application_id
required: true
scope: environment
Id of the application to associate with this environment
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
deploy_method
required: false
scope: environment
default: serverside
Default deployment method for the environment. Valid values are chef, serverside, none
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", "no_db"]
region
required: false
scope: environment
Region for the environment
network_id
required: false
scope: environment
Network ID to associate with this environment

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "network": "0714d59b-05f9-4b9d-90f2-a948144ab075",
            "environment": {
              "name": "fb787a31",
              "application_id": 5
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          
            
          {
            "environment": {
              "id": 5,
              "account": "https://api.engineyard.com/accounts/0d6e421d-4c34-4379-b9f5-12471fd72a36",
              "alerts": "https://api.engineyard.com/environments/5/server-alerts",
              "applications": "https://api.engineyard.com/environments/5/applications",
              "classic": true,
              "created_at": "2017-02-22T17:02:28+00:00",
              "database_services": "https://api.engineyard.com/environments/5/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/5/keypairs",
              "logical_databases": "https://api.engineyard.com/environments/5/logical-databases",
              "monitor_url": null,
              "name": "fb787a31",
              "server_alerts": "https://api.engineyard.com/environments/5/server-alerts",
              "servers": "https://api.engineyard.com/environments/5/servers",
              "service_level": "default",
              "service_plan": null,
              "snapshots": "https://api.engineyard.com/environments/5/snapshots",
              "updated_at": "2017-02-22T17:02:28+00:00",
              "custom_recipes": null,
              "database_stack": "postgres9_4",
              "deploy_method": "serverside",
              "deployments": "https://api.engineyard.com/environments/5/deployments",
              "framework_env": "production",
              "kubey_cluster": "https://api.engineyard.com/environments/5/kubey_cluster",
              "language": "Ruby 2.2",
              "network": "https://api.engineyard.com/environments/0714d59b-05f9-4b9d-90f2-a948144ab075",
              "region": "us-east-1",
              "release_label": "stable-v4-2.0.107",
              "requests": "https://api.engineyard.com/environments/5/requests",
              "stack_name": "nginx_passenger4",
              "username": "deploy"
            }
          }
            
          








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": "bb2d6a2e-b06d-4ec2-aa93-0be9d36f2058",
              "created_at": "2017-02-22T17:04:35+00:00",
              "started_at": "2017-02-22T17:04:35+00:00",
              "finished_at": "2017-02-22T17:05:08+00:00",
              "message": "provision_server:e5a29bce-e9f2-4c14-aa9e-1d1afde9db6e 'VolumeIOPSLimit => Volume iops of 3000 is too high; maximum is 4000. (smithy/provision_volume) [df7fc565-6d07-4ec1-9808-0b5a453e2c7f]'",
              "request_status": "Failed: Start environment (bb2d6a2e-b06d-4ec2-aa93-0be9d36f2058). Error: provision_server:e5a29bce-e9f2-4c14-aa9e-1d1afde9db6e 'VolumeIOPSLimit => Volume iops of 3000 is too high; maximum is 4000. (smithy/provision_volume) [df7fc565-6d07-4ec1-9808-0b5a453e2c7f]'",
              "successful": false,
              "updated_at": "2017-02-22T17:05:08+00:00",
              "read_channel": null,
              "stage": "start",
              "dependencies": "https://api.engineyard.com/requests/bb2d6a2e-b06d-4ec2-aa93-0be9d36f2058/dependencies",
              "stages": "https://api.engineyard.com/requests/bb2d6a2e-b06d-4ec2-aa93-0be9d36f2058/stages",
              "account": "https://api.engineyard.com/accounts/167f5800-7900-419e-87c5-c311bc21bb92",
              "requester": "https://api.engineyard.com/requests/bb2d6a2e-b06d-4ec2-aa93-0be9d36f2058/requester",
              "messages": "https://api.engineyard.com/requests/bb2d6a2e-b06d-4ec2-aa93-0be9d36f2058/messages",
              "callback_url": "https://api.engineyard.com/requests/bb2d6a2e-b06d-4ec2-aa93-0be9d36f2058/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/12"
            }
          }
            
          








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": "5fc96814-19aa-4ca4-9226-e38734ee2194",
              "created_at": "2017-02-22T17:04:16+00:00",
              "started_at": "2017-02-22T17:04:16+00:00",
              "finished_at": "2017-02-22T17:04:25+00:00",
              "message": null,
              "request_status": "Finished: Start environment (5fc96814-19aa-4ca4-9226-e38734ee2194) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:04:25+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/5fc96814-19aa-4ca4-9226-e38734ee2194/dependencies",
              "stages": "https://api.engineyard.com/requests/5fc96814-19aa-4ca4-9226-e38734ee2194/stages",
              "account": "https://api.engineyard.com/accounts/f16bfc3d-08b2-4d45-b0a7-15eec8d3e451",
              "requester": "https://api.engineyard.com/requests/5fc96814-19aa-4ca4-9226-e38734ee2194/requester",
              "messages": "https://api.engineyard.com/requests/5fc96814-19aa-4ca4-9226-e38734ee2194/messages",
              "callback_url": "https://api.engineyard.com/requests/5fc96814-19aa-4ca4-9226-e38734ee2194/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/11"
            }
          }
            
          








Delete an environment

DELETE /environments/:environment

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "destroy_environment",
              "id": "1e9234c3-4d76-4674-8dc2-ca2fe881e0a1",
              "created_at": "2017-02-22T17:06:32+00:00",
              "started_at": "2017-02-22T17:06:32+00:00",
              "finished_at": "2017-02-22T17:06:39+00:00",
              "message": null,
              "request_status": "Finished: Destroy environment (1e9234c3-4d76-4674-8dc2-ca2fe881e0a1) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:06:39+00:00",
              "read_channel": null,
              "stage": "cleanup",
              "dependencies": "https://api.engineyard.com/requests/1e9234c3-4d76-4674-8dc2-ca2fe881e0a1/dependencies",
              "stages": "https://api.engineyard.com/requests/1e9234c3-4d76-4674-8dc2-ca2fe881e0a1/stages",
              "account": "https://api.engineyard.com/accounts/a0163d2c-781b-4faa-be0d-cfba225759e6",
              "requester": "https://api.engineyard.com/requests/1e9234c3-4d76-4674-8dc2-ca2fe881e0a1/requester",
              "messages": "https://api.engineyard.com/requests/1e9234c3-4d76-4674-8dc2-ca2fe881e0a1/messages",
              "callback_url": "https://api.engineyard.com/requests/1e9234c3-4d76-4674-8dc2-ca2fe881e0a1/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/16"
            }
          }
            
          








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": "bac74a3e-f477-4206-8c70-73d34ada0bf2",
              "created_at": "2017-02-22T17:07:16+00:00",
              "started_at": "2017-02-22T17:07:16+00:00",
              "finished_at": "2017-02-22T17:07:17+00:00",
              "message": null,
              "request_status": "Finished: Configure environment (bac74a3e-f477-4206-8c70-73d34ada0bf2) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:07:17+00:00",
              "read_channel": null,
              "stage": "environment.update-instances",
              "dependencies": "https://api.engineyard.com/requests/bac74a3e-f477-4206-8c70-73d34ada0bf2/dependencies",
              "stages": "https://api.engineyard.com/requests/bac74a3e-f477-4206-8c70-73d34ada0bf2/stages",
              "account": "https://api.engineyard.com/accounts/805ef5ce-a1ba-4e1b-ba32-3d6e2c09412a",
              "requester": "https://api.engineyard.com/requests/bac74a3e-f477-4206-8c70-73d34ada0bf2/requester",
              "messages": "https://api.engineyard.com/requests/bac74a3e-f477-4206-8c70-73d34ada0bf2/messages",
              "callback_url": "https://api.engineyard.com/requests/bac74a3e-f477-4206-8c70-73d34ada0bf2/callback",
              "progress": false,
              "resource": false
            }
          }
            
          








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": 21
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "app_server_restart",
              "id": "b5104624-c436-40fe-85b2-e9ceb27886e3",
              "created_at": "2017-02-22T17:08:14+00:00",
              "started_at": "2017-02-22T17:08:14+00:00",
              "finished_at": "2017-02-22T17:08:14+00:00",
              "message": null,
              "request_status": "Finished: App server restart (b5104624-c436-40fe-85b2-e9ceb27886e3) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:08:14+00:00",
              "read_channel": null,
              "stage": "restart-app-servers",
              "dependencies": "https://api.engineyard.com/requests/b5104624-c436-40fe-85b2-e9ceb27886e3/dependencies",
              "stages": "https://api.engineyard.com/requests/b5104624-c436-40fe-85b2-e9ceb27886e3/stages",
              "account": "https://api.engineyard.com/accounts/d5a23392-9219-4b48-b5ef-c9cfd660ec2e",
              "requester": "https://api.engineyard.com/requests/b5104624-c436-40fe-85b2-e9ceb27886e3/requester",
              "messages": "https://api.engineyard.com/requests/b5104624-c436-40fe-85b2-e9ceb27886e3/messages",
              "callback_url": "https://api.engineyard.com/requests/b5104624-c436-40fe-85b2-e9ceb27886e3/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": 19,
            "maintenance": {
              "action": "enable"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "app_deployment_maintenance",
              "id": "0a864cb5-b0c4-42e0-a0da-a20d3919f582",
              "created_at": "2017-02-22T17:07:35+00:00",
              "started_at": "2017-02-22T17:07:35+00:00",
              "finished_at": "2017-02-22T17:07:36+00:00",
              "message": null,
              "request_status": "Finished: App deployment maintenance (0a864cb5-b0c4-42e0-a0da-a20d3919f582) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:07:36+00:00",
              "read_channel": null,
              "stage": "set_maintenance",
              "dependencies": "https://api.engineyard.com/requests/0a864cb5-b0c4-42e0-a0da-a20d3919f582/dependencies",
              "stages": "https://api.engineyard.com/requests/0a864cb5-b0c4-42e0-a0da-a20d3919f582/stages",
              "account": "https://api.engineyard.com/accounts/40674f27-83d5-41cf-8a50-226ece7d0515",
              "requester": "https://api.engineyard.com/requests/0a864cb5-b0c4-42e0-a0da-a20d3919f582/requester",
              "messages": "https://api.engineyard.com/requests/0a864cb5-b0c4-42e0-a0da-a20d3919f582/messages",
              "callback_url": "https://api.engineyard.com/requests/0a864cb5-b0c4-42e0-a0da-a20d3919f582/callback",
              "progress": false,
              "resource": false
            }
          }