Auto Scaling Groups API


Create an auto scaling group

POST /auto_scaling_groups

Parameters

environment
required: true
ID of the environment for which you wish to enable auto scaling
minimum_size
required: true
scope: auto_scaling_group
Minimum number of servers for the auto scaling group
maximum_size
required: true
scope: auto_scaling_group
Maximum number of servers for the auto scaling group

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "environment": 1,
            "auto_scaling_group": {
              "minimum_size": 1,
              "maximum_size": 50
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "provision_auto_scaling_group",
              "id": "d9261634-c671-430e-af2c-264a1e34e2d4",
              "created_at": "2018-04-12T18:16:27+00:00",
              "started_at": "2018-04-12T18:16:27+00:00",
              "finished_at": "2018-04-12T18:16:30+00:00",
              "message": null,
              "request_status": "Finished: Provision auto scaling group (d9261634-c671-430e-af2c-264a1e34e2d4) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-04-12T18:16:30+00:00",
              "read_channel": null,
              "stage": "protect-app-master",
              "dependencies": "https://api.engineyard.com/requests/d9261634-c671-430e-af2c-264a1e34e2d4/dependencies",
              "stages": "https://api.engineyard.com/requests/d9261634-c671-430e-af2c-264a1e34e2d4/stages",
              "account": "https://api.engineyard.com/accounts/a6301cdc-f5c7-4eff-83e4-75d303f8f75d",
              "requester": "https://api.engineyard.com/requests/d9261634-c671-430e-af2c-264a1e34e2d4/requester",
              "messages": "https://api.engineyard.com/requests/d9261634-c671-430e-af2c-264a1e34e2d4/messages",
              "callback_url": "https://api.engineyard.com/requests/d9261634-c671-430e-af2c-264a1e34e2d4/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/auto_scaling_groups/76ee91d9-1869-4285-96e5-66babab0cb9f"
            }
          }
            
          








Deprovision an auto scaling group

DELETE /auto_scaling_groups/:auto_scaling_group_id

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_auto_scaling_group",
              "id": "8d8d5ca7-7259-40ca-aec7-29cdec0e23af",
              "created_at": "2018-04-12T18:17:54+00:00",
              "started_at": "2018-04-12T18:17:54+00:00",
              "finished_at": "2018-04-12T18:17:54+00:00",
              "message": null,
              "request_status": "Finished: Deprovision auto scaling group (8d8d5ca7-7259-40ca-aec7-29cdec0e23af) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-04-12T18:17:54+00:00",
              "read_channel": null,
              "stage": "destroy",
              "dependencies": "https://api.engineyard.com/requests/8d8d5ca7-7259-40ca-aec7-29cdec0e23af/dependencies",
              "stages": "https://api.engineyard.com/requests/8d8d5ca7-7259-40ca-aec7-29cdec0e23af/stages",
              "account": "https://api.engineyard.com/accounts/73dc5cc4-2b3a-4319-9028-b18ac512569f",
              "requester": "https://api.engineyard.com/requests/8d8d5ca7-7259-40ca-aec7-29cdec0e23af/requester",
              "messages": "https://api.engineyard.com/requests/8d8d5ca7-7259-40ca-aec7-29cdec0e23af/messages",
              "callback_url": "https://api.engineyard.com/requests/8d8d5ca7-7259-40ca-aec7-29cdec0e23af/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/auto_scaling_groups/ac0744f0-5222-4554-b1fd-5c9d7995353c"
            }
          }
            
          








Get an auto scaling group

GET /auto_scaling_groups/:auto_scaling_group_id

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "auto_scaling_group": {
              "created_at": "2018-04-12T18:17:12+00:00",
              "deleted_at": null,
              "id": "ae60d718-7b26-4960-be71-9f1ff2a74fd7",
              "environment": "https://api.engineyard.com/environments/3",
              "provisioned_id": "25dd689d923bb3-a4ae-4827-90df-dd2fca9d8301",
              "minimum_size": 4,
              "maximum_size": 10,
              "desired_capacity": 4,
              "location_id": "us-east-1"
            }
          }
            
          








List auto scaling groups

GET /auto_scaling_groups

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "auto_scaling_groups": [
              {
                "created_at": "2018-04-12T18:16:50+00:00",
                "deleted_at": null,
                "id": "c465985f-6201-426e-bbf8-7675329462ac",
                "environment": "https://api.engineyard.com/environments/2",
                "provisioned_id": "1200e5a6d610eb-b83d-42b0-b9d5-74e2f2af78ec",
                "minimum_size": 4,
                "maximum_size": 10,
                "desired_capacity": 4,
                "location_id": "us-east-1"
              }
            ]
          }
            
          








Update an auto scaling group

PUT /auto_scaling_groups/:auto_scaling_group_id

Parameters

minimum_size
required: true
scope: auto_scaling_group
Minimum number of servers for the auto scaling group
maximum_size
required: true
scope: auto_scaling_group
Maximum number of servers for the auto scaling group
desired_capacity
required: true
scope: auto_scaling_group
Desired number of servers for the auto scaling group

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json
          
            
          {
            "auto_scaling_group": {
              "minimum_size": 2,
              "maximum_size": 5,
              "desired_capacity": 3
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "update_auto_scaling_group",
              "id": "df8edb8e-0310-49dd-aa4d-53667161a1fc",
              "created_at": "2018-04-12T18:17:33+00:00",
              "started_at": "2018-04-12T18:17:33+00:00",
              "finished_at": "2018-04-12T18:17:34+00:00",
              "message": null,
              "request_status": "Finished: Update auto scaling group (df8edb8e-0310-49dd-aa4d-53667161a1fc) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-04-12T18:17:34+00:00",
              "read_channel": null,
              "stage": "update",
              "dependencies": "https://api.engineyard.com/requests/df8edb8e-0310-49dd-aa4d-53667161a1fc/dependencies",
              "stages": "https://api.engineyard.com/requests/df8edb8e-0310-49dd-aa4d-53667161a1fc/stages",
              "account": "https://api.engineyard.com/accounts/ad24fe57-7e99-441d-b134-683a57eeae61",
              "requester": "https://api.engineyard.com/requests/df8edb8e-0310-49dd-aa4d-53667161a1fc/requester",
              "messages": "https://api.engineyard.com/requests/df8edb8e-0310-49dd-aa4d-53667161a1fc/messages",
              "callback_url": "https://api.engineyard.com/requests/df8edb8e-0310-49dd-aa4d-53667161a1fc/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/auto_scaling_groups/0f63e7e2-062c-4931-bea1-5ce029db3e45"
            }
          }