Providers API


Acceptable RDS flavors

GET /providers/:provider_id/database-server/flavors

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "flavors": [
              "db.m3.medium",
              "db.m3.large",
              "db.m3.xlarge",
              "db.m3.2xlarge",
              "db.m4.large",
              "db.m4.xlarge",
              "db.m4.2xlarge",
              "db.m4.4xlarge",
              "db.m4.10xlarge",
              "db.m4.16xlarge",
              "db.r3.large",
              "db.r3.xlarge",
              "db.r3.2xlarge",
              "db.r3.4xlarge",
              "db.r3.8xlarge",
              "db.t2.micro",
              "db.t2.small",
              "db.t2.medium",
              "db.t2.large"
            ]
          }
            
          








Discover locations in a known location id

PUT /providers/:provider/locations/:location/discover

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "discover_provider_location",
              "id": "c59264b9-f580-44d9-94fe-4f08eae32715",
              "created_at": "2017-02-22T17:09:10+00:00",
              "started_at": "2017-02-22T17:09:36+00:00",
              "finished_at": "2017-02-22T17:13:42+00:00",
              "message": null,
              "request_status": "Finished: Discover provider location (c59264b9-f580-44d9-94fe-4f08eae32715) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T17:13:49+00:00",
              "read_channel": null,
              "stage": "persist",
              "dependencies": "https://api.engineyard.com/requests/c59264b9-f580-44d9-94fe-4f08eae32715/dependencies",
              "stages": "https://api.engineyard.com/requests/c59264b9-f580-44d9-94fe-4f08eae32715/stages",
              "account": "https://api.engineyard.com/accounts/5f54fd59-87b7-43a0-9cab-d02cea40da82",
              "requester": "https://api.engineyard.com/requests/c59264b9-f580-44d9-94fe-4f08eae32715/requester",
              "messages": "https://api.engineyard.com/requests/c59264b9-f580-44d9-94fe-4f08eae32715/messages",
              "callback_url": "https://api.engineyard.com/requests/c59264b9-f580-44d9-94fe-4f08eae32715/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/provider-locations/c868ae69-6231-415c-9dd5-f755bad9068d"
            }
          }
            
          








List an AWS provider's locations

GET /providers/:provider/locations

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "locations": [
              {
                "id": "us-east-1",
                "name": "US East (N. Virginia)"
              },
              {
                "id": "us-east-2",
                "name": "US East (Ohio)"
              },
              {
                "id": "us-west-1",
                "name": "US West (N. California)"
              },
              {
                "id": "us-west-2",
                "name": "US West (Oregon)"
              },
              {
                "id": "ca-central-1",
                "name": "Canada (Central)"
              },
              {
                "id": "sa-east-1",
                "name": "South America (Sao Paulo)"
              },
              {
                "id": "eu-west-1",
                "name": "EU (Ireland)"
              },
              {
                "id": "eu-west-2",
                "name": "EU (London)"
              },
              {
                "id": "eu-central-1",
                "name": "EU (Frankfurt)"
              },
              {
                "id": "ap-southeast-1",
                "name": "Asia Pacific (Singapore)"
              },
              {
                "id": "ap-southeast-2",
                "name": "Asia Pacific (Sydney)"
              },
              {
                "id": "ap-northeast-1",
                "name": "Asia Pacific (Tokyo)"
              },
              {
                "id": "ap-northeast-2",
                "name": "Asia Pacific (Seoul)"
              },
              {
                "id": "ap-south-1",
                "name": "Asia Pacific (Mumbai)"
              }
            ]
          }
            
          








Acceptable RDS versions

GET /providers/:provider_id/database-server/versions

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "versions": {
              "mysql": [
                "5.6.22",
                "5.6.23",
                "5.6.27",
                "5.6.29",
                "5.7.11"
              ],
              "postgres": [
                "9.4.1",
                "9.4.4",
                "9.4.5",
                "9.4.7",
                "9.5.2"
              ],
              "aurora": [
                "5.6.10a"
              ]
            }
          }
            
          








Discover a provider's accessible locations

PUT /providers/:provider/locations/discover

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "discover_provider_locations",
              "id": "2d3f824b-9583-43fd-b302-f648293e2327",
              "created_at": "2017-02-22T17:08:32+00:00",
              "started_at": "2017-02-22T17:09:00+00:00",
              "finished_at": "2017-02-22T18:35:58+00:00",
              "message": null,
              "request_status": "Finished: Discover provider locations (2d3f824b-9583-43fd-b302-f648293e2327) (1 minute ago)",
              "successful": true,
              "updated_at": "2017-02-22T18:36:08+00:00",
              "read_channel": null,
              "stage": "discover_locations",
              "dependencies": "https://api.engineyard.com/requests/2d3f824b-9583-43fd-b302-f648293e2327/dependencies",
              "stages": "https://api.engineyard.com/requests/2d3f824b-9583-43fd-b302-f648293e2327/stages",
              "account": "https://api.engineyard.com/accounts/180f9c5c-debf-4382-ae0c-2e39e970bebb",
              "requester": "https://api.engineyard.com/requests/2d3f824b-9583-43fd-b302-f648293e2327/requester",
              "messages": "https://api.engineyard.com/requests/2d3f824b-9583-43fd-b302-f648293e2327/messages",
              "callback_url": "https://api.engineyard.com/requests/2d3f824b-9583-43fd-b302-f648293e2327/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/providers/22"
            }
          }
            
          








List Deis specific AWS flavors

GET /providers/:provider/flavors/compute

Parameters

architecture
required: false
Filter flavors by architecture (64 or 32)

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "flavors": [
              {
                "id": "m3_medium",
                "api_name": "m3.medium",
                "dedicated": false,
                "description": "General Purpose (M3) Medium",
                "volume_optimized": false,
                "architecture": 64,
                "name": "m3_medium"
              },
              {
                "id": "m3_large",
                "api_name": "m3.large",
                "dedicated": false,
                "description": "General Purpose (M3) Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "m3_large"
              },
              {
                "id": "m3_xlarge",
                "api_name": "m3.xlarge",
                "dedicated": false,
                "description": "General Purpose (M3) Extra Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "m3_xlarge"
              },
              {
                "id": "c4_large",
                "api_name": "c4.large",
                "dedicated": false,
                "description": "Compute Optimized (C4) Large",
                "volume_optimized": true,
                "architecture": 64,
                "name": "c4_large"
              },
              {
                "id": "c4_xlarge",
                "api_name": "c4.xlarge",
                "dedicated": false,
                "description": "Compute Optimized (C4) Extra Large",
                "volume_optimized": true,
                "architecture": 64,
                "name": "c4_xlarge"
              },
              {
                "id": "c3_large",
                "api_name": "c3.large",
                "dedicated": false,
                "description": "Compute Optimized (C3) Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "c3_large"
              },
              {
                "id": "c3_xlarge",
                "api_name": "c3.xlarge",
                "dedicated": false,
                "description": "Compute Optimized (C3) Extra Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "c3_xlarge"
              },
              {
                "id": "r3_large",
                "api_name": "r3.large",
                "dedicated": false,
                "description": "Memory Optimized (R3) Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "r3_large"
              },
              {
                "id": "r3_xlarge",
                "api_name": "r3.xlarge",
                "dedicated": false,
                "description": "Memory Optimized (R3) Extra Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "r3_xlarge"
              },
              {
                "id": "t2_micro",
                "api_name": "t2.micro",
                "dedicated": false,
                "description": "General Purpose (T2) Micro",
                "volume_optimized": false,
                "architecture": 64,
                "name": "t2_micro"
              },
              {
                "id": "t2_small",
                "api_name": "t2.small",
                "dedicated": false,
                "description": "General Purpose (T2) Small",
                "volume_optimized": false,
                "architecture": 64,
                "name": "t2_small"
              },
              {
                "id": "t2_medium",
                "api_name": "t2.medium",
                "dedicated": false,
                "description": "General Purpose (T2) Medium",
                "volume_optimized": false,
                "architecture": 64,
                "name": "t2_medium"
              },
              {
                "id": "t2_large",
                "api_name": "t2.large",
                "dedicated": false,
                "description": "General Purpose (T2) Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "t2_large"
              },
              {
                "id": "t2_xlarge",
                "api_name": "t2.xlarge",
                "dedicated": false,
                "description": "General Purpose (T2) Extra Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "t2_xlarge"
              },
              {
                "id": "m4_large",
                "api_name": "m4.large",
                "dedicated": false,
                "description": "General Purpose (M4) Large",
                "volume_optimized": true,
                "architecture": 64,
                "name": "m4_large"
              },
              {
                "id": "m4_xlarge",
                "api_name": "m4.xlarge",
                "dedicated": false,
                "description": "General Purpose (M4) Extra Large",
                "volume_optimized": true,
                "architecture": 64,
                "name": "m4_xlarge"
              }
            ]
          }
            
          








Acceptable RDS options

GET /providers/:provider_id/database-server

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "database_server": {
              "flavors": [
                "db.m3.medium",
                "db.m3.large",
                "db.m3.xlarge",
                "db.m3.2xlarge",
                "db.m4.large",
                "db.m4.xlarge",
                "db.m4.2xlarge",
                "db.m4.4xlarge",
                "db.m4.10xlarge",
                "db.m4.16xlarge",
                "db.r3.large",
                "db.r3.xlarge",
                "db.r3.2xlarge",
                "db.r3.4xlarge",
                "db.r3.8xlarge",
                "db.t2.micro",
                "db.t2.small",
                "db.t2.medium",
                "db.t2.large"
              ],
              "engine_versions": {
                "mysql": [
                  "5.6.22",
                  "5.6.23",
                  "5.6.27",
                  "5.6.29",
                  "5.7.11"
                ],
                "postgres": [
                  "9.4.1",
                  "9.4.4",
                  "9.4.5",
                  "9.4.7",
                  "9.5.2"
                ],
                "aurora": [
                  "5.6.10a"
                ]
              }
            }
          }
            
          








List only AWS providers

GET /accounts/:account_id/providers

Parameters

type
required: false
Type of provider. One of ["aws", "azure"]

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "providers": [
              {
                "id": 16,
                "account": "https://api.engineyard.com/accounts/d72877f8-ec41-4588-951a-4d77de4559db",
                "cancelled_at": null,
                "created_at": "2017-02-22T17:06:27+00:00",
                "database_server_snapshots": "https://api.engineyard.com/providers/16/database-server-snapshots",
                "provider_locations": "https://api.engineyard.com/providers/16/locations",
                "provisioned_id": "2359630343",
                "servers": "https://api.engineyard.com/providers/16/servers",
                "shared": false,
                "storages": "https://api.engineyard.com/providers/16/storages",
                "type": "aws",
                "untracked_servers": "https://api.engineyard.com/providers/16/untracked-servers",
                "updated_at": "2017-02-22T17:06:27+00:00"
              }
            ]
          }
            
          








List all providers

GET /accounts/:account_id/providers

Parameters

type
required: false
Type of provider. One of ["aws", "azure"]

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "providers": [
              {
                "id": 15,
                "account": "https://api.engineyard.com/accounts/3edcb197-fec0-480e-9170-cc59bf0035da",
                "cancelled_at": null,
                "created_at": "2017-02-22T17:06:17+00:00",
                "database_server_snapshots": "https://api.engineyard.com/providers/15/database-server-snapshots",
                "provider_locations": "https://api.engineyard.com/providers/15/locations",
                "provisioned_id": "5549199229",
                "servers": "https://api.engineyard.com/providers/15/servers",
                "shared": false,
                "storages": "https://api.engineyard.com/providers/15/storages",
                "type": "aws",
                "untracked_servers": "https://api.engineyard.com/providers/15/untracked-servers",
                "updated_at": "2017-02-22T17:06:17+00:00"
              }
            ]
          }
            
          








List an AWS provider's flavors

GET /providers/:provider/flavors/compute

Parameters

architecture
required: false
Filter flavors by architecture (64 or 32)

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "flavors": [
              {
                "id": "m3_medium",
                "api_name": "m3.medium",
                "dedicated": false,
                "description": "General Purpose (M3) Medium",
                "volume_optimized": false,
                "architecture": 64,
                "name": "m3_medium"
              },
              {
                "id": "m3_large",
                "api_name": "m3.large",
                "dedicated": false,
                "description": "General Purpose (M3) Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "m3_large"
              },
              {
                "id": "m3_xlarge",
                "api_name": "m3.xlarge",
                "dedicated": false,
                "description": "General Purpose (M3) Extra Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "m3_xlarge"
              },
              {
                "id": "c4_large",
                "api_name": "c4.large",
                "dedicated": false,
                "description": "Compute Optimized (C4) Large",
                "volume_optimized": true,
                "architecture": 64,
                "name": "c4_large"
              },
              {
                "id": "c4_xlarge",
                "api_name": "c4.xlarge",
                "dedicated": false,
                "description": "Compute Optimized (C4) Extra Large",
                "volume_optimized": true,
                "architecture": 64,
                "name": "c4_xlarge"
              },
              {
                "id": "c3_large",
                "api_name": "c3.large",
                "dedicated": false,
                "description": "Compute Optimized (C3) Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "c3_large"
              },
              {
                "id": "c3_xlarge",
                "api_name": "c3.xlarge",
                "dedicated": false,
                "description": "Compute Optimized (C3) Extra Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "c3_xlarge"
              },
              {
                "id": "r3_large",
                "api_name": "r3.large",
                "dedicated": false,
                "description": "Memory Optimized (R3) Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "r3_large"
              },
              {
                "id": "r3_xlarge",
                "api_name": "r3.xlarge",
                "dedicated": false,
                "description": "Memory Optimized (R3) Extra Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "r3_xlarge"
              },
              {
                "id": "t2_micro",
                "api_name": "t2.micro",
                "dedicated": false,
                "description": "General Purpose (T2) Micro",
                "volume_optimized": false,
                "architecture": 64,
                "name": "t2_micro"
              },
              {
                "id": "t2_small",
                "api_name": "t2.small",
                "dedicated": false,
                "description": "General Purpose (T2) Small",
                "volume_optimized": false,
                "architecture": 64,
                "name": "t2_small"
              },
              {
                "id": "t2_medium",
                "api_name": "t2.medium",
                "dedicated": false,
                "description": "General Purpose (T2) Medium",
                "volume_optimized": false,
                "architecture": 64,
                "name": "t2_medium"
              },
              {
                "id": "t2_large",
                "api_name": "t2.large",
                "dedicated": false,
                "description": "General Purpose (T2) Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "t2_large"
              },
              {
                "id": "t2_xlarge",
                "api_name": "t2.xlarge",
                "dedicated": false,
                "description": "General Purpose (T2) Extra Large",
                "volume_optimized": false,
                "architecture": 64,
                "name": "t2_xlarge"
              },
              {
                "id": "m4_large",
                "api_name": "m4.large",
                "dedicated": false,
                "description": "General Purpose (M4) Large",
                "volume_optimized": true,
                "architecture": 64,
                "name": "m4_large"
              },
              {
                "id": "m4_xlarge",
                "api_name": "m4.xlarge",
                "dedicated": false,
                "description": "General Purpose (M4) Extra Large",
                "volume_optimized": true,
                "architecture": 64,
                "name": "m4_xlarge"
              }
            ]
          }
            
          








Show an AWS provider

GET /providers/:provider

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "provider": {
              "id": 17,
              "account": "https://api.engineyard.com/accounts/007c1165-bde7-4304-9a08-28da8df3deba",
              "cancelled_at": null,
              "created_at": "2017-02-22T17:06:37+00:00",
              "database_server_snapshots": "https://api.engineyard.com/providers/17/database-server-snapshots",
              "provider_locations": "https://api.engineyard.com/providers/17/locations",
              "provisioned_id": "1475582799",
              "servers": "https://api.engineyard.com/providers/17/servers",
              "shared": false,
              "storages": "https://api.engineyard.com/providers/17/storages",
              "type": "aws",
              "untracked_servers": "https://api.engineyard.com/providers/17/untracked-servers",
              "updated_at": "2017-02-22T17:06:37+00:00"
            }
          }