Environments API

---

• Boot an environment from a blueprint
• Boot an environment from a blueprint with an IP specified
• Boot an environment with a custom configuration
• Boot an environment with a production configuration
• Boot an environment with a solo configuration
• Boot an environment with a staging configuration
• Boot an environment with one app server and a separate database server
• Create an environment
• Create an environment with a custom database stack
• Create an environment with a custom framework environment
• Create an environment with a custom language
• Create an environment with an associated network
• Create an environment with encrypted EBS volumes
• Delete an environment
• Deploy an application to an environment
• Disable maintenance on an application in an environment
• Enable maintenance on an application in an environment
• List environments
• Restart app servers (unicorn, puma, etc)
• Run chef on an environment
• Save a blueprint of an environment
• Stop an environment

Boot an environment from a blueprint

POST /environments/:environment/boot

Parameters

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          

            
          {
            "cluster_configuration": {
              "blueprint_id": "e8e8e70d-098f-4510-b9bd-813d4a86c161"
            }
          }
            
          

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

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          

            
          {
            "cluster_configuration": {
              "blueprint_id": "edc9062c-9d87-4234-8176-0c303e8700fa",
              "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

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": "44c5409c-9d3e-4cc3-8943-6c36ac9e0d92",
              "created_at": "2018-05-29T10:43:06+00:00",
              "started_at": "2018-05-29T10:43:06+00:00",
              "finished_at": "2018-05-29T10:43:41+00:00",
              "message": "provision_server:6af11690-671f-4a24-a700-62bc7da15ce4 'VolumeIOPSLimit => Volume iops of 3000 is too high; maximum is 4000. (smithy/provision_volume) [4caf3c03-a370-499e-bc0d-19346a93cb7b]'",
              "request_status": "Failed: Start environment (44c5409c-9d3e-4cc3-8943-6c36ac9e0d92). Error: provision_server:6af11690-671f-4a24-a700-62bc7da15ce4 'VolumeIOPSLimit => Volume iops of 3000 is too high; maximum is 4000. (smithy/provision_volume) [4caf3c03-a370-499e-bc0d-19346a93cb7b]'",
              "successful": false,
              "updated_at": "2018-05-29T10:43:41+00:00",
              "read_channel": null,
              "stage": "start",
              "dependencies": "https://api.engineyard.com/requests/44c5409c-9d3e-4cc3-8943-6c36ac9e0d92/dependencies",
              "stages": "https://api.engineyard.com/requests/44c5409c-9d3e-4cc3-8943-6c36ac9e0d92/stages",
              "account": "https://api.engineyard.com/accounts/6ab9c42c-6455-419c-91c1-f475739e9613",
              "requester": "https://api.engineyard.com/requests/44c5409c-9d3e-4cc3-8943-6c36ac9e0d92/requester",
              "messages": "https://api.engineyard.com/requests/44c5409c-9d3e-4cc3-8943-6c36ac9e0d92/messages",
              "callback_url": "https://api.engineyard.com/requests/44c5409c-9d3e-4cc3-8943-6c36ac9e0d92/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

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": "5fce02ff-42dc-4fec-bfce-9155565d3ac6",
              "created_at": "2018-05-29T10:42:49+00:00",
              "started_at": "2018-05-29T10:42:49+00:00",
              "finished_at": "2018-05-29T10:43:00+00:00",
              "message": null,
              "request_status": "Finished: Start environment (5fce02ff-42dc-4fec-bfce-9155565d3ac6) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:43:00+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/5fce02ff-42dc-4fec-bfce-9155565d3ac6/dependencies",
              "stages": "https://api.engineyard.com/requests/5fce02ff-42dc-4fec-bfce-9155565d3ac6/stages",
              "account": "https://api.engineyard.com/accounts/86f12dbd-6dbe-49b1-8a4a-0ebcb3352aa7",
              "requester": "https://api.engineyard.com/requests/5fce02ff-42dc-4fec-bfce-9155565d3ac6/requester",
              "messages": "https://api.engineyard.com/requests/5fce02ff-42dc-4fec-bfce-9155565d3ac6/messages",
              "callback_url": "https://api.engineyard.com/requests/5fce02ff-42dc-4fec-bfce-9155565d3ac6/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

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": "16787d8e-2f11-42a9-9267-0b5f06e88d49",
              "created_at": "2018-05-29T10:42:08+00:00",
              "started_at": "2018-05-29T10:42:08+00:00",
              "finished_at": "2018-05-29T10:42:22+00:00",
              "message": null,
              "request_status": "Finished: Start environment (16787d8e-2f11-42a9-9267-0b5f06e88d49) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:42:22+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/16787d8e-2f11-42a9-9267-0b5f06e88d49/dependencies",
              "stages": "https://api.engineyard.com/requests/16787d8e-2f11-42a9-9267-0b5f06e88d49/stages",
              "account": "https://api.engineyard.com/accounts/43e07aff-b6d2-492a-8b64-7c05b7e78af9",
              "requester": "https://api.engineyard.com/requests/16787d8e-2f11-42a9-9267-0b5f06e88d49/requester",
              "messages": "https://api.engineyard.com/requests/16787d8e-2f11-42a9-9267-0b5f06e88d49/messages",
              "callback_url": "https://api.engineyard.com/requests/16787d8e-2f11-42a9-9267-0b5f06e88d49/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

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": "fbffff44-0410-4591-805c-90d303f14e47",
              "created_at": "2018-05-29T10:42:26+00:00",
              "started_at": "2018-05-29T10:42:26+00:00",
              "finished_at": "2018-05-29T10:42:45+00:00",
              "message": null,
              "request_status": "Finished: Start environment (fbffff44-0410-4591-805c-90d303f14e47) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:42:45+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/fbffff44-0410-4591-805c-90d303f14e47/dependencies",
              "stages": "https://api.engineyard.com/requests/fbffff44-0410-4591-805c-90d303f14e47/stages",
              "account": "https://api.engineyard.com/accounts/ffbedf9a-9f31-4db4-8fc0-d95edcd2ad1e",
              "requester": "https://api.engineyard.com/requests/fbffff44-0410-4591-805c-90d303f14e47/requester",
              "messages": "https://api.engineyard.com/requests/fbffff44-0410-4591-805c-90d303f14e47/messages",
              "callback_url": "https://api.engineyard.com/requests/fbffff44-0410-4591-805c-90d303f14e47/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

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": "604378a7-7116-4996-ad5e-04a88be70d43",
              "created_at": "2018-05-29T10:43:45+00:00",
              "started_at": "2018-05-29T10:43:45+00:00",
              "finished_at": "2018-05-29T10:44:00+00:00",
              "message": null,
              "request_status": "Finished: Start environment (604378a7-7116-4996-ad5e-04a88be70d43) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:44:00+00:00",
              "read_channel": null,
              "stage": "wait-for-instance-updates",
              "dependencies": "https://api.engineyard.com/requests/604378a7-7116-4996-ad5e-04a88be70d43/dependencies",
              "stages": "https://api.engineyard.com/requests/604378a7-7116-4996-ad5e-04a88be70d43/stages",
              "account": "https://api.engineyard.com/accounts/161b1862-2c4a-4909-90dd-a5bdc2972019",
              "requester": "https://api.engineyard.com/requests/604378a7-7116-4996-ad5e-04a88be70d43/requester",
              "messages": "https://api.engineyard.com/requests/604378a7-7116-4996-ad5e-04a88be70d43/messages",
              "callback_url": "https://api.engineyard.com/requests/604378a7-7116-4996-ad5e-04a88be70d43/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/19"
            }
          }
            
          

---

Create an environment

POST /accounts/:account/environments

Parameters

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/74c16961-d75e-477f-8a43-d81eabedb1eb",
              "alerts": "https://api.engineyard.com/environments/6/server-alerts",
              "applications": "https://api.engineyard.com/environments/6/applications",
              "classic": true,
              "created_at": "2018-05-29T10:41:38+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": "2018-05-29T10:41: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/6/deployments",
              "encrypted_database_ebs": false,
              "encrypted_ebs_for_everything": false,
              "environment_variables": "https://api.engineyard.com/environments/6/environment_variables",
              "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.126",
              "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

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          

            
          {
            "environment": {
              "name": "4dccac69",
              "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/49110ee2-1a92-4b2f-8d4f-fe01b690e36c",
              "alerts": "https://api.engineyard.com/environments/10/server-alerts",
              "applications": "https://api.engineyard.com/environments/10/applications",
              "classic": true,
              "created_at": "2018-05-29T10:41:49+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": "4dccac69",
              "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": "2018-05-29T10:41:49+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,
              "environment_variables": "https://api.engineyard.com/environments/10/environment_variables",
              "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.126",
              "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

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          

            
          {
            "environment": {
              "name": "93123f53",
              "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/a3ced210-6929-4ff7-a9d3-ad8d934d569a",
              "alerts": "https://api.engineyard.com/environments/7/server-alerts",
              "applications": "https://api.engineyard.com/environments/7/applications",
              "classic": true,
              "created_at": "2018-05-29T10:41:41+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": "93123f53",
              "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": "2018-05-29T10:41:41+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,
              "environment_variables": "https://api.engineyard.com/environments/7/environment_variables",
              "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.126",
              "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

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          

            
          {
            "environment": {
              "name": "79607983",
              "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/3354966d-8cee-48b0-9f11-f3cf8952b459",
              "alerts": "https://api.engineyard.com/environments/9/server-alerts",
              "applications": "https://api.engineyard.com/environments/9/applications",
              "classic": true,
              "created_at": "2018-05-29T10:41:46+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": "79607983",
              "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": "2018-05-29T10:41:46+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,
              "environment_variables": "https://api.engineyard.com/environments/9/environment_variables",
              "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.126",
              "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

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          

            
          {
            "network": "2cfa49e2-3e5c-41e0-b116-830438333605",
            "environment": {
              "name": "48e743c1",
              "application_id": 27
            }
          }
            
          

Response

          Status: 201 Created
          Content-Type: application/json; charset=utf-8
          

            
          {
            "environment": {
              "id": 11,
              "account": "https://api.engineyard.com/accounts/52e331ca-04f7-4dc3-9a0a-8f7c7a687f07",
              "alerts": "https://api.engineyard.com/environments/11/server-alerts",
              "applications": "https://api.engineyard.com/environments/11/applications",
              "classic": true,
              "created_at": "2018-05-29T10:41:55+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": "48e743c1",
              "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": "2018-05-29T10:41:55+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,
              "environment_variables": "https://api.engineyard.com/environments/11/environment_variables",
              "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/2cfa49e2-3e5c-41e0-b116-830438333605",
              "region": "us-east-1",
              "release_label": "stable-v4-2.0.126",
              "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-17cd14f8"
            }
          }
            
          

---

Create an environment with encrypted EBS volumes

POST /accounts/:account/environments

Parameters

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          

            
          {
            "environment": {
              "name": "c0f46000",
              "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/4e724bd9-56a1-469b-8150-aea82101a798",
              "alerts": "https://api.engineyard.com/environments/8/server-alerts",
              "applications": "https://api.engineyard.com/environments/8/applications",
              "classic": true,
              "created_at": "2018-05-29T10:41:43+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": "c0f46000",
              "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": "2018-05-29T10:41: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_4",
              "deploy_method": "serverside",
              "deployments": "https://api.engineyard.com/environments/8/deployments",
              "encrypted_database_ebs": false,
              "encrypted_ebs_for_everything": true,
              "environment_variables": "https://api.engineyard.com/environments/8/environment_variables",
              "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.126",
              "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

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          

            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          

            
          {
            "request": {
              "type": "destroy_environment",
              "id": "7a4241a8-91be-49c9-b180-03e2c58fede7",
              "created_at": "2018-05-29T10:44:50+00:00",
              "started_at": "2018-05-29T10:44:50+00:00",
              "finished_at": "2018-05-29T10:44:58+00:00",
              "message": null,
              "request_status": "Finished: Destroy environment (7a4241a8-91be-49c9-b180-03e2c58fede7) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:44:58+00:00",
              "read_channel": null,
              "stage": "cleanup",
              "dependencies": "https://api.engineyard.com/requests/7a4241a8-91be-49c9-b180-03e2c58fede7/dependencies",
              "stages": "https://api.engineyard.com/requests/7a4241a8-91be-49c9-b180-03e2c58fede7/stages",
              "account": "https://api.engineyard.com/accounts/ad3a130c-c844-4ec3-bbd0-68a7d9625aee",
              "requester": "https://api.engineyard.com/requests/7a4241a8-91be-49c9-b180-03e2c58fede7/requester",
              "messages": "https://api.engineyard.com/requests/7a4241a8-91be-49c9-b180-03e2c58fede7/messages",
              "callback_url": "https://api.engineyard.com/requests/7a4241a8-91be-49c9-b180-03e2c58fede7/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/22"
            }
          }
            
          

---

Deploy an application to an environment

POST /environments/:environment/deploy

Parameters

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": "b33419cb-aa0d-4653-b724-c12388ef5a6a",
              "created_at": "2018-05-29T10:45:11+00:00",
              "started_at": "2018-05-29T10:45:11+00:00",
              "finished_at": "2018-05-29T10:45:12+00:00",
              "message": null,
              "request_status": "Finished: App deployment (b33419cb-aa0d-4653-b724-c12388ef5a6a) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:45:12+00:00",
              "read_channel": "https://messages.engineyard.com/stream?subscription=%2Frequests%2Fb33419cb&token=193cbf31b50158b4ee156eddbe433c3b",
              "stage": "deploy",
              "dependencies": "https://api.engineyard.com/requests/b33419cb-aa0d-4653-b724-c12388ef5a6a/dependencies",
              "stages": "https://api.engineyard.com/requests/b33419cb-aa0d-4653-b724-c12388ef5a6a/stages",
              "account": "https://api.engineyard.com/accounts/23db0878-36f1-47c3-9873-d0f15d5608e6",
              "requester": "https://api.engineyard.com/requests/b33419cb-aa0d-4653-b724-c12388ef5a6a/requester",
              "messages": "https://api.engineyard.com/requests/b33419cb-aa0d-4653-b724-c12388ef5a6a/messages",
              "callback_url": "https://api.engineyard.com/requests/b33419cb-aa0d-4653-b724-c12388ef5a6a/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/deployments/9"
            }
          }
            
          

---

Disable maintenance on an application in an environment

PUT /environments/:environment/maintenance

Parameters

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": "8c595adf-2d2c-4db7-9337-237f5e09f4f9",
              "created_at": "2018-05-29T10:45:57+00:00",
              "started_at": "2018-05-29T10:45:57+00:00",
              "finished_at": "2018-05-29T10:45:57+00:00",
              "message": null,
              "request_status": "Finished: App deployment maintenance (8c595adf-2d2c-4db7-9337-237f5e09f4f9) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:45:57+00:00",
              "read_channel": null,
              "stage": "set_maintenance",
              "dependencies": "https://api.engineyard.com/requests/8c595adf-2d2c-4db7-9337-237f5e09f4f9/dependencies",
              "stages": "https://api.engineyard.com/requests/8c595adf-2d2c-4db7-9337-237f5e09f4f9/stages",
              "account": "https://api.engineyard.com/accounts/4ff3951b-ed00-4b7b-b83b-e48c2839bc32",
              "requester": "https://api.engineyard.com/requests/8c595adf-2d2c-4db7-9337-237f5e09f4f9/requester",
              "messages": "https://api.engineyard.com/requests/8c595adf-2d2c-4db7-9337-237f5e09f4f9/messages",
              "callback_url": "https://api.engineyard.com/requests/8c595adf-2d2c-4db7-9337-237f5e09f4f9/callback",
              "progress": false,
              "resource": false
            }
          }
            
          

---

Enable maintenance on an application in an environment

PUT /environments/:environment/maintenance

Parameters

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": "035a81a1-9e41-4e7b-a6dc-623ae506bd9f",
              "created_at": "2018-05-29T10:45:43+00:00",
              "started_at": "2018-05-29T10:45:43+00:00",
              "finished_at": "2018-05-29T10:45:43+00:00",
              "message": null,
              "request_status": "Finished: App deployment maintenance (035a81a1-9e41-4e7b-a6dc-623ae506bd9f) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:45:43+00:00",
              "read_channel": null,
              "stage": "set_maintenance",
              "dependencies": "https://api.engineyard.com/requests/035a81a1-9e41-4e7b-a6dc-623ae506bd9f/dependencies",
              "stages": "https://api.engineyard.com/requests/035a81a1-9e41-4e7b-a6dc-623ae506bd9f/stages",
              "account": "https://api.engineyard.com/accounts/085a0c8d-218d-497d-ba92-0dd20bec9753",
              "requester": "https://api.engineyard.com/requests/035a81a1-9e41-4e7b-a6dc-623ae506bd9f/requester",
              "messages": "https://api.engineyard.com/requests/035a81a1-9e41-4e7b-a6dc-623ae506bd9f/messages",
              "callback_url": "https://api.engineyard.com/requests/035a81a1-9e41-4e7b-a6dc-623ae506bd9f/callback",
              "progress": false,
              "resource": false
            }
          }
            
          

---

List environments

GET /environments

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          

            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          

            
          {
            "environments": [
              {
                "id": 12,
                "account": "https://api.engineyard.com/accounts/0d2c5946-a273-4eb3-9f25-bc6fc0fed62d",
                "alerts": "https://api.engineyard.com/environments/12/server-alerts",
                "applications": "https://api.engineyard.com/environments/12/applications",
                "classic": true,
                "created_at": "2018-05-29T10:41:58+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": "b7d0f7",
                "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": "2018-05-29T10:41:58+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,
                "environment_variables": "https://api.engineyard.com/environments/12/environment_variables",
                "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.126",
                "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

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": "97c26ab3-fa5d-4209-9a14-c3f5f8409145",
              "created_at": "2018-05-29T10:46:11+00:00",
              "started_at": "2018-05-29T10:46:11+00:00",
              "finished_at": "2018-05-29T10:46:12+00:00",
              "message": null,
              "request_status": "Finished: App server restart (97c26ab3-fa5d-4209-9a14-c3f5f8409145) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:46:12+00:00",
              "read_channel": null,
              "stage": "restart-app-servers",
              "dependencies": "https://api.engineyard.com/requests/97c26ab3-fa5d-4209-9a14-c3f5f8409145/dependencies",
              "stages": "https://api.engineyard.com/requests/97c26ab3-fa5d-4209-9a14-c3f5f8409145/stages",
              "account": "https://api.engineyard.com/accounts/5d5d4868-c82b-4cf5-9a03-f7dd9bb612c2",
              "requester": "https://api.engineyard.com/requests/97c26ab3-fa5d-4209-9a14-c3f5f8409145/requester",
              "messages": "https://api.engineyard.com/requests/97c26ab3-fa5d-4209-9a14-c3f5f8409145/messages",
              "callback_url": "https://api.engineyard.com/requests/97c26ab3-fa5d-4209-9a14-c3f5f8409145/callback",
              "progress": false,
              "resource": false
            }
          }
            
          

---

Run chef on an environment

POST /environments/:environment/apply

Parameters

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          

            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          

            
          {
            "request": {
              "type": "configure_environment",
              "id": "5929f906-87c0-4a50-aa47-ab64e0ed8059",
              "created_at": "2018-05-29T10:45:27+00:00",
              "started_at": "2018-05-29T10:45:27+00:00",
              "finished_at": "2018-05-29T10:45:28+00:00",
              "message": null,
              "request_status": "Finished: Configure environment (5929f906-87c0-4a50-aa47-ab64e0ed8059) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:45:28+00:00",
              "read_channel": null,
              "stage": "environment.update-instances",
              "dependencies": "https://api.engineyard.com/requests/5929f906-87c0-4a50-aa47-ab64e0ed8059/dependencies",
              "stages": "https://api.engineyard.com/requests/5929f906-87c0-4a50-aa47-ab64e0ed8059/stages",
              "account": "https://api.engineyard.com/accounts/77c3f51f-425e-4483-b8bb-1761931ad4b1",
              "requester": "https://api.engineyard.com/requests/5929f906-87c0-4a50-aa47-ab64e0ed8059/requester",
              "messages": "https://api.engineyard.com/requests/5929f906-87c0-4a50-aa47-ab64e0ed8059/messages",
              "callback_url": "https://api.engineyard.com/requests/5929f906-87c0-4a50-aa47-ab64e0ed8059/callback",
              "progress": false,
              "resource": false
            }
          }
            
          

---

Save a blueprint of an environment

POST /environments/:environment/blueprint

Parameters

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          

            
          {
            "name": "c65fa9"
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          

            
          {
            "blueprint": {
              "id": "e92b44b2-39e2-400a-bcbf-852af372fb4d",
              "account": "https://api.engineyard.com/accounts/0f7acec5-f696-48e9-919f-54d42accaf89",
              "environment": "https://api.engineyard.com/environments/20",
              "created_at": "2018-05-29T10:44:14+00:00",
              "updated_at": "2018-05-29T10:44:14+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": "c65fa9"
            }
          }
            
          

---

Stop an environment

PUT /environments/:environment/deprovision

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          

            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          

            
          {
            "request": {
              "type": "deprovision_environment",
              "id": "6a785b79-253b-4c15-a7dc-0d89198192c5",
              "created_at": "2018-05-29T10:44:29+00:00",
              "started_at": "2018-05-29T10:44:29+00:00",
              "finished_at": "2018-05-29T10:44:36+00:00",
              "message": null,
              "request_status": "Finished: Deprovision environment (6a785b79-253b-4c15-a7dc-0d89198192c5) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:44:36+00:00",
              "read_channel": null,
              "stage": "notify",
              "dependencies": "https://api.engineyard.com/requests/6a785b79-253b-4c15-a7dc-0d89198192c5/dependencies",
              "stages": "https://api.engineyard.com/requests/6a785b79-253b-4c15-a7dc-0d89198192c5/stages",
              "account": "https://api.engineyard.com/accounts/31c01806-5622-49e7-abde-568e7c33d1d7",
              "requester": "https://api.engineyard.com/requests/6a785b79-253b-4c15-a7dc-0d89198192c5/requester",
              "messages": "https://api.engineyard.com/requests/6a785b79-253b-4c15-a7dc-0d89198192c5/messages",
              "callback_url": "https://api.engineyard.com/requests/6a785b79-253b-4c15-a7dc-0d89198192c5/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/environments/21"
            }
          }
            
          

---