Database services API


Create a database service

POST /database-services

Parameters

name
required: false
scope: database_service
Name of the database server
provider
required: true
Provider to create database server in
network
required: false
Network to create the database servers in
notes
required: false
scope: database_service
Addition information (i.e. additonal emergency information)
engine
required: false
scope: database_server
Database engine to be used
version
required: true
scope: database_server
Version number of the database engine
flavor
required: true
scope: database_server
Server flavor
location
required: true
scope: database_server
Location of the database server
storage
required: false
scope: database_server
Storage space in GB
service_level
required: false
scope: database_service
support service level #<ServiceLevels [#<ServiceLevels::Level [0] "community" [:august2015, :free]>, #<ServiceLevels::Level [1] "standard" [:august2015, :paid_support]>, #<ServiceLevels::Level [2] "premium" [:august2015, :contact_required, :paid_support]>, #<ServiceLevels::Level [3] "platform-only" alternate: "self-service" [:may2015]>, #<ServiceLevels::Level [4] "level-1" [:may2015]>, #<ServiceLevels::Level [5] "level-2" [:may2015, :contact_required, :multi_az_required]>, #<ServiceLevels::Level [6] "level-3" [:may2015, :contact_required, :multi_az_required]>, #<ServiceLevels::Level [7] "orphaned-012016" [:jan2016]>, #<ServiceLevels::Level [8] "standard-012016" [:jan2016]>, #<ServiceLevels::Level [9] "premium-012016" [:jan2016]>]>
modifiers
required: false
scope: database_server
Example: { 'multi_az' => 'true' }
email_alert_level
required: false
scope: database_service
The threshold for sending alert emails. Integer value 1-3. Default is 2.
backup_retention_period
required: false
scope: database_server
Backup retention period (1-35)
backup_window
required: false
scope: database_server
Example: { 'start_time' => { 'hour' => '01', 'minute' => '00' }, 'duration' => 1 }
storage_encrypted
required: false
scope: database_server
Should the database server be encrypted

Request

          Content-Type: application/json
          Accept: application/vnd.engineyard.v3+json
          
            
          {
            "provider": 146,
            "database_service": {
              "name": "my-database-server",
              "service_level": "level-1",
              "notes": "Asperiores veniam minima consequatur vero consequatur."
            },
            "database_server": {
              "flavor": "db.m3.large",
              "engine": "postgres",
              "version": "9.4.11",
              "location": "us-west-2a",
              "storage": 50,
              "modifiers": {
                "multi_az": true
              }
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "provision_database_service",
              "id": "a14ca358-df36-46f2-9e40-c21b49247669",
              "created_at": "2018-04-12T18:03:02+00:00",
              "started_at": "2018-04-12T18:03:02+00:00",
              "finished_at": "2018-04-12T18:03:05+00:00",
              "message": null,
              "request_status": "Finished: Provision database service (a14ca358-df36-46f2-9e40-c21b49247669) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-04-12T18:03:05+00:00",
              "read_channel": null,
              "stage": "create-provider-credentials",
              "dependencies": "https://api.engineyard.com/requests/a14ca358-df36-46f2-9e40-c21b49247669/dependencies",
              "stages": "https://api.engineyard.com/requests/a14ca358-df36-46f2-9e40-c21b49247669/stages",
              "account": "https://api.engineyard.com/accounts/adac96c6-7ddb-4d37-8b7b-3fe4b55c0273",
              "requester": "https://api.engineyard.com/requests/a14ca358-df36-46f2-9e40-c21b49247669/requester",
              "messages": "https://api.engineyard.com/requests/a14ca358-df36-46f2-9e40-c21b49247669/messages",
              "callback_url": "https://api.engineyard.com/requests/a14ca358-df36-46f2-9e40-c21b49247669/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/database-services/c4b4aca6-b66a-4436-a147-7e42c1ec432f"
            }
          }
            
          








Create a database service in a network

POST /database-services

Parameters

name
required: false
scope: database_service
Name of the database server
provider
required: true
Provider to create database server in
network
required: false
Network to create the database servers in
notes
required: false
scope: database_service
Addition information (i.e. additonal emergency information)
engine
required: false
scope: database_server
Database engine to be used
version
required: true
scope: database_server
Version number of the database engine
flavor
required: true
scope: database_server
Server flavor
location
required: true
scope: database_server
Location of the database server
storage
required: false
scope: database_server
Storage space in GB
service_level
required: false
scope: database_service
support service level #<ServiceLevels [#<ServiceLevels::Level [0] "community" [:august2015, :free]>, #<ServiceLevels::Level [1] "standard" [:august2015, :paid_support]>, #<ServiceLevels::Level [2] "premium" [:august2015, :contact_required, :paid_support]>, #<ServiceLevels::Level [3] "platform-only" alternate: "self-service" [:may2015]>, #<ServiceLevels::Level [4] "level-1" [:may2015]>, #<ServiceLevels::Level [5] "level-2" [:may2015, :contact_required, :multi_az_required]>, #<ServiceLevels::Level [6] "level-3" [:may2015, :contact_required, :multi_az_required]>, #<ServiceLevels::Level [7] "orphaned-012016" [:jan2016]>, #<ServiceLevels::Level [8] "standard-012016" [:jan2016]>, #<ServiceLevels::Level [9] "premium-012016" [:jan2016]>]>
modifiers
required: false
scope: database_server
Example: { 'multi_az' => 'true' }
email_alert_level
required: false
scope: database_service
The threshold for sending alert emails. Integer value 1-3. Default is 2.
backup_retention_period
required: false
scope: database_server
Backup retention period (1-35)
backup_window
required: false
scope: database_server
Example: { 'start_time' => { 'hour' => '01', 'minute' => '00' }, 'duration' => 1 }
storage_encrypted
required: false
scope: database_server
Should the database server be encrypted

Request

          Content-Type: application/json
          Accept: application/vnd.engineyard.v3+json
          
            
          {
            "provider": 147,
            "network": "756fba8f-f3e4-4a0e-bb69-9ccbb79247bd",
            "database_service": {
              "name": "my-database-server",
              "service_level": "level-1",
              "notes": "Dicta aut perferendis ex et."
            },
            "database_server": {
              "flavor": "db.m3.large",
              "engine": "postgres",
              "version": "9.4.11",
              "location": "us-east-1a",
              "storage": 50,
              "modifiers": {
                "multi_az": true
              }
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "provision_database_service",
              "id": "87acc914-593c-4432-978b-55b0f20bd142",
              "created_at": "2018-04-12T18:03:10+00:00",
              "started_at": "2018-04-12T18:03:10+00:00",
              "finished_at": "2018-04-12T18:03:12+00:00",
              "message": null,
              "request_status": "Finished: Provision database service (87acc914-593c-4432-978b-55b0f20bd142) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-04-12T18:03:12+00:00",
              "read_channel": null,
              "stage": "create-provider-credentials",
              "dependencies": "https://api.engineyard.com/requests/87acc914-593c-4432-978b-55b0f20bd142/dependencies",
              "stages": "https://api.engineyard.com/requests/87acc914-593c-4432-978b-55b0f20bd142/stages",
              "account": "https://api.engineyard.com/accounts/b7e1066d-1bf9-4d02-bcb6-fa688b36ee3d",
              "requester": "https://api.engineyard.com/requests/87acc914-593c-4432-978b-55b0f20bd142/requester",
              "messages": "https://api.engineyard.com/requests/87acc914-593c-4432-978b-55b0f20bd142/messages",
              "callback_url": "https://api.engineyard.com/requests/87acc914-593c-4432-978b-55b0f20bd142/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/database-services/841bfb93-9798-4465-a57e-64928fd9088f"
            }
          }
            
          








Deprovision a database service

DELETE /database-services/:database_service

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "deprovision_database_service",
              "id": "f0397648-9030-4183-a6b3-164cdbf22a5b",
              "created_at": "2018-04-12T18:04:15+00:00",
              "started_at": "2018-04-12T18:04:15+00:00",
              "finished_at": "2018-04-12T18:04:17+00:00",
              "message": null,
              "request_status": "Finished: Deprovision database service (f0397648-9030-4183-a6b3-164cdbf22a5b) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-04-12T18:04:17+00:00",
              "read_channel": null,
              "stage": "destroy",
              "dependencies": "https://api.engineyard.com/requests/f0397648-9030-4183-a6b3-164cdbf22a5b/dependencies",
              "stages": "https://api.engineyard.com/requests/f0397648-9030-4183-a6b3-164cdbf22a5b/stages",
              "account": "https://api.engineyard.com/accounts/564a776b-53df-4c08-a575-cf48f67f9770",
              "requester": "https://api.engineyard.com/requests/f0397648-9030-4183-a6b3-164cdbf22a5b/requester",
              "messages": "https://api.engineyard.com/requests/f0397648-9030-4183-a6b3-164cdbf22a5b/messages",
              "callback_url": "https://api.engineyard.com/requests/f0397648-9030-4183-a6b3-164cdbf22a5b/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/database-services/bb2edd63-1363-4dda-bc9c-627cced76409"
            }
          }
            
          








Get a database master's logs URL

GET /database-services/:database_service/logs

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "logs_url": "https://signin.aws.amazon.com/federation?Action=login&Issuer=https://sso.localdev.engineyard.com:9292&SigninToken=OUHESAKTQmiFOwXzRSnPcHMH6pg+5frVF82F+Ch8JaaOW30BPmIu608qsO9ts/xNSl+OCRbQ84OTOEvcpr6VxLYSZH98m5RGBth+LzUPLC1BBESeXm+bzKV8tUv0q6x3k/FqmYXL1SXTk78rjDypVvQaLv48Hy7s5SXoENwewlWmMfWLwAMrTVGD1E2lDURHg6szYsk07DujC5s42gfqsoy92AHD+1FbwE1tYNq2oouGsl/mx4r1mrAWqZl6HFCmMRjnRZ0ulYmtIoSYnVyBA6B76CBjs4hMXSBGzhpCSoNEJ7Gd+bVU+e3CWAENdVdfcY2IgJhqJu+5n4iFfLAaA6cp2SX7Tp6Mp2BPQQZg+6U/cMo60KVdTT7YOizKnGkxiRc6kE8rxfaUsYOyySbLpWmN7AgU1YHrb2eg2ZMa9OF+pxoRpVUYrbiU/OIoAJwyxHt9NVtK5VppCndCo8Sp9Avm2F83P0ES3ISQOOql7KuruS13Q8b8A1bDojSxpk71zoEMk2rREFy7oxP5ufBlFKsU3y+Y8ynhloG+XCaM8ybM+Ro1Nn3q+EQInqzOeGGTDoCyC3qo/W4+nzvvUxM/Tx1E4BmEXXeKHDA9TgCz9eKv3/dWXKhacufEVMEc2NtWT7EYf7FXkYxi9mXGTqnY5g8Z+fUGZtONiknacljUvphhYyT8NTNQyXWl3gR1sqyV0u+ByAxb88dqRUOA3r4ZJ/VBiLX2CKOFon6TOhA/rzGnPG5b&Destination=https%3A%2F%2Fus-west-2.console.aws.amazon.com%2Frds%2Fhome%3Fregion%3Dus-west-2%23dbinstance%3Aid%3Drds-98049ef5b3%3Bview%3Dlogs"
          }
            
          








Get a database replica's logs URL

GET /database-services/:database_service/logs

Parameters

database_server
required: false
ID of the database server who's logs url you want

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "logs_url": "https://signin.aws.amazon.com/federation?Action=login&Issuer=https://sso.localdev.engineyard.com:9292&SigninToken=DOaRxcR1sWxhZCSBrjjlixHHtl5dH4zkpB9jsWjdZ0GSX6IlP36PD8gDD7GyRMFxHDfPJvnoCfi1UxX46eWO01Mk5DvXxPXqvTw7+xI7vsJHpA2jewEhi1YWFHJElVrOL/ND0tEcxOmcR5VA5igRu7ikKk9+Z7dIz7YlW5+XRnL02SdiMnME7Ba4a1GQFx/8JlmZYIVXr+gRH4pDtTLnB8CuojQ8C7dI7/hrPHum2T60ENRlW0NFYgKSsbZgKWrtkuzdZMphMeeS4X7Mad37w6JodgHITCMM7tHLJK1m9I/v2KyvMYHSO+DI9Y2bafNF2i5h3nKk6WO7qlIrW7ssgtsnEyXTNllm8J0np5M9uCsH6mh/XiWoC79JS0rfS8X6eiMGW2trjD11d86FrI7St8pFZ+j6gIsPStOrPy0dzdAlS4mLJzyicu45Hm9oKRor6kFuJa+lL5XVIoUyag5luAi5l76tDtRRMPQ3Lt3PVnCwGjiFtFUDMiYtWRsLm8u+1GHUe0shosCdvHijqjASTfTUmwc73A2eRLO/B6JlELix0ujg0NCwoixWETIZCyRDPU0X4vS57ozmqnqWtKAFacMrQ66YAxhGjJzQAvqndo32ZVomaEztCuV0X7hgKRb7vXRmlMPc2Bk3NWA/Z+krIyzUryCUEv+mxDdEBnbS/3EC/iZRE12Ot0dSll9WDBl3nm7CqfLWtexHcBHgAaW12sMtDfKdXphBkjvy7eUjdxjrsPVt&Destination=https%3A%2F%2Fus-east-1.console.aws.amazon.com%2Frds%2Fhome%3Fregion%3Dus-east-1%23dbinstance%3Aid%3Drds-bfd8d7a846%3Bview%3Dlogs"
          }
            
          








Get a database service's events URL

GET /database-services/:database_service/events

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "events_url": "https://signin.aws.amazon.com/federation?Action=login&Issuer=https://sso.localdev.engineyard.com:9292&SigninToken=2m+x5Rdr32YTrh3XWStIlJOPAY0a0lGKk1jY15HVVjgVua12Tp6VCNOiKix8upSOdWNYodTn+vDZQT/lyW7PMkHguHSm5cm0C71RDfmxX/M/LuYMrENtYCSW04lTCFklRc9Zp8rIGYEpj1Bdei69JFhlFNqdAKSIomA3fE0y6umwNgjvnh6CENfT4QvefE0zeZchn8pnMpppfw7jxOsJ4Tfsri7/4XIFkVtk5aLJ/BkpIzzZbSHnDjsdRun2Z0fLYrDbLLDrNuLJaIo68B3qWH8Gyp2i5xjlwUc6SxXLIUimDap9VnU6wrS46/JO9pJ4mmLbqMjNjlwEA2yUkruKYO/T+2uHAnmPDUrT9kQ5sJOKmqZ/9DAm93SQgUTJKeHpt9919NSgicTF5JCes7sVF7I3+yUUueLgSJVdMQiKsBa4BbeL5qfZfAj6J84uezGfslOwapT+DrUI5WoNbAgGb6LI5GdKhX2P9LRqQIn/JySBOSvf6fWMHLil24CWniJsszAVqIxLM2auD/AwLb2fazFoNAS2W2vKQkjpTliZsUyadlGHGYqMbL3fL12mFVXRBFmGThZ4hP/PiZa3WJ0vC/juUPvCQuzSWbQ+Vy8bII//nbdIJrLuZdCpjxWjJraGe4/jFm58JCzJGbMPhsS9gJZIDjE0upMKAaQxtYWlrfqgoDfFetYBK2LFYxPZEIbdynzLPb6Y0XYN8q1swzt20VSoe5XlCrmD6FR8rC3fN1KTRX6U&Destination=https%3A%2F%2Fus-east-1.console.aws.amazon.com%2Frds%2Fhome%3Fregion%3Dus-east-1%23events%3A"
          }
            
          








Get a database service's metrics URL

GET /database-services/:database_service/metrics

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "metrics_url": "https://signin.aws.amazon.com/federation?Action=login&Issuer=https://sso.localdev.engineyard.com:9292&SigninToken=owZURk0lfMoyhHT6OeO2Tn5OFNFdZOccHV9EapPKYtA8WpRAG6TC9o3jXu4YjJRLmpwo/LlpqKEVYz82psiRK3ubC8bgq5YYX02QtLnegJU+tYaZqACsW1xs0Ddy+OR/Th8PEUVbbvOd3uvwRk4Ea23e2ozDAY6fX295hx6Z5bOw6zyvH3gCJru0YhziT+hZI9d4yYmgYclVPT1CHVofoqg3pnc5O35hQE4GJdTqYPFnjzgdBh9rpP/VkdfdzZhaKRJj8sZWguS3BdUbhyfhY/yTRp/Uq9Rzl1tyQm9v55Otag8v8YuYilZzBEIxy9VsOLh7j2uTKv85NbMX8X42Kv8uQi2ibdr1D7nPH7/oTNbhxBR2Z4uUrQaXczBeTC6eH02MbQpW5nJ6pMIyn+7K1iashL1xIigsI+c8eQmqwQzbm1mqNUlO0kLq9lwYHyq4z5H+iXf9s2XAY2KPKF1sfs9d+e7CIO0fW64LB3QDIE0v2cex8WupN7W8JvNoxQ40VnYR7EbVY7GXo+7b8pe78hy4pKU99xqaY8QiVawkXuqIQZTzJ5DnZkMl72fyg+38RsQX5hWA22Vlxw0Cf04lTHJZt+ZHCx9kA0CFq0S+haMn2qX8OkFrqOqZ9FZTZJGxu4lhCVEwYl4bHf8CVmMyHKnqmRgSMETB09VC2aegWQG7P0GscXj6KVWahC4vKWzl+gvbcuscBOQCGVXBiFbV+q3zTDx6Abb6rhRC/Tg/azLKMBqQ&Destination=https%3A%2F%2Fus-east-1.console.aws.amazon.com%2Frds%2Fhome%3Fregion%3Dus-east-1%23dbinstances%3Aid%3Drds-e33e2a3852%3Bsf%3Dall%3Bv%3Dmm"
          }
            
          








Get a database service

GET /database-services/:database_service

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "database_service": {
              "id": "14f42c2f-b545-4435-8a9e-9d02d5e82aa9",
              "alerts": "https://api.engineyard.com/database-services/14f42c2f-b545-4435-8a9e-9d02d5e82aa9/alerts",
              "created_at": "2018-04-12T18:03:45+00:00",
              "databases": "https://api.engineyard.com/database-services/14f42c2f-b545-4435-8a9e-9d02d5e82aa9/databases",
              "deleted_at": null,
              "email_alert_level": 2,
              "engine": "postgres",
              "location": "us-west-2",
              "messages": "https://api.engineyard.com/database-services/14f42c2f-b545-4435-8a9e-9d02d5e82aa9/messages",
              "name": "87aaed",
              "network": null,
              "notes": null,
              "password": "6d68740a1e91",
              "provider": "https://api.engineyard.com/providers/153",
              "requests": "https://api.engineyard.com/database-services/14f42c2f-b545-4435-8a9e-9d02d5e82aa9/requests",
              "servers": "https://api.engineyard.com/database-services/14f42c2f-b545-4435-8a9e-9d02d5e82aa9/servers",
              "service_level": "level-1",
              "service_plan": "https://api.engineyard.com/database-services/14f42c2f-b545-4435-8a9e-9d02d5e82aa9/service_plans/d942ca77-9781-468b-8dd9-ba192c75b265",
              "snapshots": "https://api.engineyard.com/database-services/14f42c2f-b545-4435-8a9e-9d02d5e82aa9/snapshots",
              "updated_at": "2018-04-12T18:03:46+00:00",
              "username": "ey_admin",
              "version": "9.6.3",
              "db_engine_type": "postgres",
              "db_master_multi_az": null,
              "db_master_flavor": "db.m3.large",
              "db_replica_count": 0,
              "connected_kubey_cluster_count": 0,
              "connected_kubey_environments": "https://api.engineyard.com/environments?database_service_id=14f42c2f-b545-4435-8a9e-9d02d5e82aa9&kubey=true",
              "vpc_name": null,
              "vpc_provisioned_id": null
            }
          }
            
          








Get database services servers

GET /database-services/:database_service/servers

Parameters

provisioned_id
required: false
Filter by infrastructure ID (i.e., 'i-b28d7df2')
provisioner_id
required: false
Filter by provisioner ID
endpoint
required: false
Filter by database url
engine
required: false
Filter by database engine to be used
version
required: false
Filter by database engine version number
storage
required: false
Filter by storage space in GB

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "database_servers": [
              {
                "id": "e0846104-4e4c-424b-a2a0-80685acb9c7b",
                "alerts": "https://api.engineyard.com/database-servers/e0846104-4e4c-424b-a2a0-80685acb9c7b/alerts",
                "created_at": "2018-04-12T18:03:40+00:00",
                "database_service": "https://api.engineyard.com/database-services/3f3500a5-6e0d-4bea-80fe-9d896ecd8f55",
                "deleted_at": null,
                "endpoint": "mysql://rds-cfbf29943c.ppvljgyd.us-east-1.rds.amazonaws.com:5432",
                "engine": "mysql",
                "firewalls": "https://api.engineyard.com/database-servers/e0846104-4e4c-424b-a2a0-80685acb9c7b/firewalls",
                "flavor": "db.m3.large",
                "location": "us-east-1a",
                "messages": "https://api.engineyard.com/database-servers/e0846104-4e4c-424b-a2a0-80685acb9c7b/messages",
                "modifiers": {
                  "storage_type": "gp2"
                },
                "network": null,
                "password": "5eb4eb4b6149",
                "provider": "https://api.engineyard.com/providers/152",
                "provisioned_id": "rds-cfbf29943c",
                "revisions": "https://api.engineyard.com/database-servers/e0846104-4e4c-424b-a2a0-80685acb9c7b/revisions",
                "replication_source": null,
                "snapshots": "https://api.engineyard.com/database-servers/e0846104-4e4c-424b-a2a0-80685acb9c7b/snapshots",
                "storage": 100,
                "updated_at": "2018-04-12T18:03:40+00:00",
                "username": "ey_admin",
                "version": "5.6.23",
                "preferred_maintenance_window": {
                  "start": {
                    "day": "monday",
                    "hour": "08",
                    "minute": "30"
                  },
                  "end": {
                    "day": "monday",
                    "hour": "09",
                    "minute": "00"
                  }
                },
                "backup_retention_period": 35,
                "storage_encrypted": false,
                "storage_type": "gp2",
                "backup_window": {
                  "start": {
                    "hour": "04",
                    "minute": "30"
                  },
                  "duration": "0.5"
                }
              }
            ]
          }
            
          








List a database service's messages

GET /database-services/:database_service/messages

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "messages": [
              {
                "id": "03514b59-2aad-46f1-a888-75f40d7e2718",
                "created_at": "2018-04-12T18:03:51+00:00",
                "message": "Modi incidunt pariatur voluptas.",
                "type": null,
                "resource": null,
                "stage": null
              }
            ]
          }
            
          








List all database services on a specific provider

GET /providers/:provider_id/database-services

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "database_services": [
              {
                "id": "75a4d41f-a3be-43c1-a66e-1d9694e3a35e",
                "alerts": "https://api.engineyard.com/database-services/75a4d41f-a3be-43c1-a66e-1d9694e3a35e/alerts",
                "created_at": "2018-04-12T18:03:36+00:00",
                "databases": "https://api.engineyard.com/database-services/75a4d41f-a3be-43c1-a66e-1d9694e3a35e/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "postgres",
                "location": "us-west-2",
                "messages": "https://api.engineyard.com/database-services/75a4d41f-a3be-43c1-a66e-1d9694e3a35e/messages",
                "name": "3928b5",
                "network": null,
                "notes": null,
                "password": "6d0f17f56562",
                "provider": "https://api.engineyard.com/providers/151",
                "requests": "https://api.engineyard.com/database-services/75a4d41f-a3be-43c1-a66e-1d9694e3a35e/requests",
                "servers": "https://api.engineyard.com/database-services/75a4d41f-a3be-43c1-a66e-1d9694e3a35e/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/75a4d41f-a3be-43c1-a66e-1d9694e3a35e/service_plans/c71e38f2-2863-42fe-b2fe-4a9b83ca40c2",
                "snapshots": "https://api.engineyard.com/database-services/75a4d41f-a3be-43c1-a66e-1d9694e3a35e/snapshots",
                "updated_at": "2018-04-12T18:03:36+00:00",
                "username": "ey_admin",
                "version": "9.5.2",
                "db_engine_type": "postgres",
                "db_master_multi_az": null,
                "db_master_flavor": "db.m3.large",
                "db_replica_count": 0,
                "connected_kubey_cluster_count": 0,
                "connected_kubey_environments": "https://api.engineyard.com/environments?database_service_id=75a4d41f-a3be-43c1-a66e-1d9694e3a35e&kubey=true",
                "vpc_name": null,
                "vpc_provisioned_id": null
              },
              {
                "id": "05bdc3d7-02aa-4969-b1fa-15235f607efc",
                "alerts": "https://api.engineyard.com/database-services/05bdc3d7-02aa-4969-b1fa-15235f607efc/alerts",
                "created_at": "2018-04-12T18:03:34+00:00",
                "databases": "https://api.engineyard.com/database-services/05bdc3d7-02aa-4969-b1fa-15235f607efc/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "postgres",
                "location": "us-east-1",
                "messages": "https://api.engineyard.com/database-services/05bdc3d7-02aa-4969-b1fa-15235f607efc/messages",
                "name": "12fcd2",
                "network": null,
                "notes": null,
                "password": "1e402d6a05a6",
                "provider": "https://api.engineyard.com/providers/151",
                "requests": "https://api.engineyard.com/database-services/05bdc3d7-02aa-4969-b1fa-15235f607efc/requests",
                "servers": "https://api.engineyard.com/database-services/05bdc3d7-02aa-4969-b1fa-15235f607efc/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/05bdc3d7-02aa-4969-b1fa-15235f607efc/service_plans/caa7db5e-4672-40bc-ac40-7428f680ea9b",
                "snapshots": "https://api.engineyard.com/database-services/05bdc3d7-02aa-4969-b1fa-15235f607efc/snapshots",
                "updated_at": "2018-04-12T18:03:34+00:00",
                "username": "ey_admin",
                "version": "9.6.3",
                "db_engine_type": "postgres",
                "db_master_multi_az": null,
                "db_master_flavor": "db.m3.large",
                "db_replica_count": 0,
                "connected_kubey_cluster_count": 0,
                "connected_kubey_environments": "https://api.engineyard.com/environments?database_service_id=05bdc3d7-02aa-4969-b1fa-15235f607efc&kubey=true",
                "vpc_name": null,
                "vpc_provisioned_id": null
              }
            ]
          }
            
          








List all database services on an account

GET /accounts/:account_id/database-services

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "database_services": [
              {
                "id": "2646668e-b216-4470-90e6-8a66aa65e4e7",
                "alerts": "https://api.engineyard.com/database-services/2646668e-b216-4470-90e6-8a66aa65e4e7/alerts",
                "created_at": "2018-04-12T18:03:29+00:00",
                "databases": "https://api.engineyard.com/database-services/2646668e-b216-4470-90e6-8a66aa65e4e7/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "mysql",
                "location": "us-west-2",
                "messages": "https://api.engineyard.com/database-services/2646668e-b216-4470-90e6-8a66aa65e4e7/messages",
                "name": "adf4de",
                "network": null,
                "notes": null,
                "password": "4788a8e6b880",
                "provider": "https://api.engineyard.com/providers/150",
                "requests": "https://api.engineyard.com/database-services/2646668e-b216-4470-90e6-8a66aa65e4e7/requests",
                "servers": "https://api.engineyard.com/database-services/2646668e-b216-4470-90e6-8a66aa65e4e7/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/2646668e-b216-4470-90e6-8a66aa65e4e7/service_plans/7bf61baa-8832-4e99-95ee-4912e27f310e",
                "snapshots": "https://api.engineyard.com/database-services/2646668e-b216-4470-90e6-8a66aa65e4e7/snapshots",
                "updated_at": "2018-04-12T18:03:29+00:00",
                "username": "ey_admin",
                "version": "5.7.16",
                "db_engine_type": "mysql",
                "db_master_multi_az": null,
                "db_master_flavor": "db.m3.large",
                "db_replica_count": 0,
                "connected_kubey_cluster_count": 0,
                "connected_kubey_environments": "https://api.engineyard.com/environments?database_service_id=2646668e-b216-4470-90e6-8a66aa65e4e7&kubey=true",
                "vpc_name": null,
                "vpc_provisioned_id": null
              },
              {
                "id": "7f1dbd27-1f1d-4e21-a37c-109c8acbfb2e",
                "alerts": "https://api.engineyard.com/database-services/7f1dbd27-1f1d-4e21-a37c-109c8acbfb2e/alerts",
                "created_at": "2018-04-12T18:03:26+00:00",
                "databases": "https://api.engineyard.com/database-services/7f1dbd27-1f1d-4e21-a37c-109c8acbfb2e/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "mysql",
                "location": "us-east-1",
                "messages": "https://api.engineyard.com/database-services/7f1dbd27-1f1d-4e21-a37c-109c8acbfb2e/messages",
                "name": "68d43e",
                "network": null,
                "notes": null,
                "password": "6daa7096dadb",
                "provider": "https://api.engineyard.com/providers/150",
                "requests": "https://api.engineyard.com/database-services/7f1dbd27-1f1d-4e21-a37c-109c8acbfb2e/requests",
                "servers": "https://api.engineyard.com/database-services/7f1dbd27-1f1d-4e21-a37c-109c8acbfb2e/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/7f1dbd27-1f1d-4e21-a37c-109c8acbfb2e/service_plans/703064b8-ed3a-48ec-abec-e91d5d6fb737",
                "snapshots": "https://api.engineyard.com/database-services/7f1dbd27-1f1d-4e21-a37c-109c8acbfb2e/snapshots",
                "updated_at": "2018-04-12T18:03:26+00:00",
                "username": "ey_admin",
                "version": "5.7.11",
                "db_engine_type": "mysql",
                "db_master_multi_az": null,
                "db_master_flavor": "db.m3.large",
                "db_replica_count": 0,
                "connected_kubey_cluster_count": 0,
                "connected_kubey_environments": "https://api.engineyard.com/environments?database_service_id=7f1dbd27-1f1d-4e21-a37c-109c8acbfb2e&kubey=true",
                "vpc_name": null,
                "vpc_provisioned_id": null
              }
            ]
          }
            
          








List database services

GET /database-services

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "database_services": [
              {
                "id": "aa924010-771c-4e2e-bacb-450b09803115",
                "alerts": "https://api.engineyard.com/database-services/aa924010-771c-4e2e-bacb-450b09803115/alerts",
                "created_at": "2018-04-12T18:03:22+00:00",
                "databases": "https://api.engineyard.com/database-services/aa924010-771c-4e2e-bacb-450b09803115/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "mysql",
                "location": "us-west-2",
                "messages": "https://api.engineyard.com/database-services/aa924010-771c-4e2e-bacb-450b09803115/messages",
                "name": "faff82",
                "network": null,
                "notes": null,
                "password": "167c6575c4b1",
                "provider": "https://api.engineyard.com/providers/149",
                "requests": "https://api.engineyard.com/database-services/aa924010-771c-4e2e-bacb-450b09803115/requests",
                "servers": "https://api.engineyard.com/database-services/aa924010-771c-4e2e-bacb-450b09803115/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/aa924010-771c-4e2e-bacb-450b09803115/service_plans/9b8f877d-61bd-4023-9bb1-145c13802226",
                "snapshots": "https://api.engineyard.com/database-services/aa924010-771c-4e2e-bacb-450b09803115/snapshots",
                "updated_at": "2018-04-12T18:03:22+00:00",
                "username": "ey_admin",
                "version": "5.6.27",
                "db_engine_type": "mysql",
                "db_master_multi_az": null,
                "db_master_flavor": "db.m3.large",
                "db_replica_count": 0,
                "connected_kubey_cluster_count": 0,
                "connected_kubey_environments": "https://api.engineyard.com/environments?database_service_id=aa924010-771c-4e2e-bacb-450b09803115&kubey=true",
                "vpc_name": null,
                "vpc_provisioned_id": null
              }
            ]
          }
            
          








Updates a provisioned database service

PUT /database-services/:database_service_id/provisioned

Parameters

name
required: false
scope: database_service
New name of the database service
flavor_id
required: false
scope: database_service
New flavor_id for the database servers
notes
required: false
scope: database_service
Notes for the database service
service_level
required: false
scope: database_service
New database service support level

Request

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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "update_database_service",
              "id": "edfb8bf2-e6a9-414d-9069-dff36ef0f756",
              "created_at": "2018-04-12T18:03:17+00:00",
              "started_at": "2018-04-12T18:03:17+00:00",
              "finished_at": "2018-04-12T18:03:17+00:00",
              "message": null,
              "request_status": "Finished: Update database service (edfb8bf2-e6a9-414d-9069-dff36ef0f756) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-04-12T18:03:17+00:00",
              "read_channel": null,
              "stage": "update",
              "dependencies": "https://api.engineyard.com/requests/edfb8bf2-e6a9-414d-9069-dff36ef0f756/dependencies",
              "stages": "https://api.engineyard.com/requests/edfb8bf2-e6a9-414d-9069-dff36ef0f756/stages",
              "account": "https://api.engineyard.com/accounts/5f3007c1-558f-4cee-a9b4-d99031c797f8",
              "requester": "https://api.engineyard.com/requests/edfb8bf2-e6a9-414d-9069-dff36ef0f756/requester",
              "messages": "https://api.engineyard.com/requests/edfb8bf2-e6a9-414d-9069-dff36ef0f756/messages",
              "callback_url": "https://api.engineyard.com/requests/edfb8bf2-e6a9-414d-9069-dff36ef0f756/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/database-services/8c8c1308-0ec4-474b-bbc1-96bc3c671e9c"
            }
          }