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": "Eum vel voluptatum enim necessitatibus quibusdam asperiores."
            },
            "database_server": {
              "flavor": "db.m3.large",
              "engine": "postgres",
              "version": "9.4.11",
              "location": "us-east-1d",
              "storage": 50,
              "modifiers": {
                "multi_az": true
              }
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "provision_database_service",
              "id": "18fea401-d24d-4252-8c9c-fd22f4ecbd8b",
              "created_at": "2017-10-10T15:52:26+00:00",
              "started_at": "2017-10-10T15:52:26+00:00",
              "finished_at": "2017-10-10T15:52:28+00:00",
              "message": null,
              "request_status": "Finished: Provision database service (18fea401-d24d-4252-8c9c-fd22f4ecbd8b) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:52:28+00:00",
              "read_channel": null,
              "stage": "create-provider-credentials",
              "dependencies": "https://api.engineyard.com/requests/18fea401-d24d-4252-8c9c-fd22f4ecbd8b/dependencies",
              "stages": "https://api.engineyard.com/requests/18fea401-d24d-4252-8c9c-fd22f4ecbd8b/stages",
              "account": "https://api.engineyard.com/accounts/f975cc37-47eb-4dc9-b272-12b5f6840064",
              "requester": "https://api.engineyard.com/requests/18fea401-d24d-4252-8c9c-fd22f4ecbd8b/requester",
              "messages": "https://api.engineyard.com/requests/18fea401-d24d-4252-8c9c-fd22f4ecbd8b/messages",
              "callback_url": "https://api.engineyard.com/requests/18fea401-d24d-4252-8c9c-fd22f4ecbd8b/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/database-services/e22d9869-4c17-4fc7-90df-3abc74315356"
            }
          }
            
          








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": "b01a1ec6-070b-42ff-a4c3-a3d126f57cad",
            "database_service": {
              "name": "my-database-server",
              "service_level": "level-1",
              "notes": "Delectus dolorum quaerat eum et cum eligendi."
            },
            "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": "a3a01fd7-ec1f-46bf-99dc-250df4c46fe5",
              "created_at": "2017-10-10T15:52:33+00:00",
              "started_at": "2017-10-10T15:52:33+00:00",
              "finished_at": "2017-10-10T15:52:35+00:00",
              "message": null,
              "request_status": "Finished: Provision database service (a3a01fd7-ec1f-46bf-99dc-250df4c46fe5) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:52:35+00:00",
              "read_channel": null,
              "stage": "create-provider-credentials",
              "dependencies": "https://api.engineyard.com/requests/a3a01fd7-ec1f-46bf-99dc-250df4c46fe5/dependencies",
              "stages": "https://api.engineyard.com/requests/a3a01fd7-ec1f-46bf-99dc-250df4c46fe5/stages",
              "account": "https://api.engineyard.com/accounts/55d5655a-0d7d-4c16-b121-b98dd670509a",
              "requester": "https://api.engineyard.com/requests/a3a01fd7-ec1f-46bf-99dc-250df4c46fe5/requester",
              "messages": "https://api.engineyard.com/requests/a3a01fd7-ec1f-46bf-99dc-250df4c46fe5/messages",
              "callback_url": "https://api.engineyard.com/requests/a3a01fd7-ec1f-46bf-99dc-250df4c46fe5/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/database-services/be1873f0-e5ef-451a-b1de-6b9d3e9bf209"
            }
          }
            
          








Deprovision a database service

DELETE /database-services/:database_service

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "deprovision_database_service",
              "id": "ea880fc3-cde0-4fe9-9c33-8b13bd626775",
              "created_at": "2017-10-10T15:53:35+00:00",
              "started_at": "2017-10-10T15:53:35+00:00",
              "finished_at": "2017-10-10T15:53:36+00:00",
              "message": null,
              "request_status": "Finished: Deprovision database service (ea880fc3-cde0-4fe9-9c33-8b13bd626775) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:53:36+00:00",
              "read_channel": null,
              "stage": "destroy",
              "dependencies": "https://api.engineyard.com/requests/ea880fc3-cde0-4fe9-9c33-8b13bd626775/dependencies",
              "stages": "https://api.engineyard.com/requests/ea880fc3-cde0-4fe9-9c33-8b13bd626775/stages",
              "account": "https://api.engineyard.com/accounts/06a1e8c2-d3cf-434d-8d7b-4c3ff09eb75a",
              "requester": "https://api.engineyard.com/requests/ea880fc3-cde0-4fe9-9c33-8b13bd626775/requester",
              "messages": "https://api.engineyard.com/requests/ea880fc3-cde0-4fe9-9c33-8b13bd626775/messages",
              "callback_url": "https://api.engineyard.com/requests/ea880fc3-cde0-4fe9-9c33-8b13bd626775/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/database-services/e095771c-6342-4708-8809-306bdebdf5e3"
            }
          }
            
          








Get a database master's logs URL

GET /database-services/:database_service/logs

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=2oLX9hG0Xqh82XsR88+eG/AgsO3b1cSBWbmGWFaQUcHlkVIxXSpGK4lqu64dIiFMDRo33RjrM73y+dP1ZLAL/ydFmReyHRzK1p5ZSxMu6R4QgZPcY6lJeL5lcnEmfyqm00Ks6ZyJiaqBdNV0/r3Hl/fJuOj/chA2InkiOOxEaXzhRSOGT/MIIKZx70Xf7vczG/6QQiWf6pvKoTIsuvVnSZfAev29y3DoBtgVnsoCaIzeQ0XEQDjqxb7pnMZSHdiu/FIDVM7dQUaonOAsMzDeB78HT9+gvSDqJT7AE9uVkPv69R1vAm8tKTmu5Gx8i2rCQOsksMFS9A4fpO6jhs6p2y4r/HJAWFh9YQPvTSGLpkbq2viRnKdbhkfRja1rDTyMUf3NP++Fc+UesUaLqMPovFmrDyRBKv1E4Yw+zc/u+aapKP3XkjFZ678IYqJS1AeHnJckTQJMyqagOduUgocXA0YX0ijeM7pnjbAoKl/cbhs20nfTM6w/jBzbKrr1JXLvwS7a/3WQCAPLx2y5wltHGyWemC4wNsj6TYwMxcWKRtEyw8c5rmZF4pql3gPYaQw02ruEq8caW2nBv66idNHxxQY5SsLIA7WUO6jX9GL9KjP+JkflWg7h0AZl2zHUj0MzlMky+Z98xP5WKicw+CF6PwwjUFqft6DZJq7YfECnQQ+Idwg6ZlmVE5xjcVpkpPV7cMl2IROBiJNoBTz8WFNEAEdPkZ9T5Jdjuei7qNM3EchGgzYE&Destination=https%3A%2F%2Fus-east-1.console.aws.amazon.com%2Frds%2Fhome%3Fregion%3Dus-east-1%23dbinstance%3Aid%3Drds-855f02a627%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

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=/14O2R7sLzUL5amcjptdCe9+PodyV7s8WCtkaF26Xc2jgGpAzs07UdDm5KfDLjtYWhIZQCJOI1UvkNNECtA8QwSUFzmPVKGj/Kfq/x+gFmKL07Fn3pLrIBkwMG9QGAgJlFNJgyNAp5h9t+a/kwVMhkyIDlibc93KCaC6+iBhzuzRynmw8oaim1u+sDHPSo0qHsnND4RHxtFYi1GCpULLU8FS/nZGB0fNqDqr0W0dLzPCtuggoFgJ0DvqM9pryr9FDvoWsyebM6VsXecad3fXiat6O6r/5M382/CxXuldS4Fru+BT4duI1XYbBuE9+t3NInZHBIUf92O5C04flgMK6GOhnSPoXQvXw1Gw3Yyf3WgYMN2puthRYcp5ngC7T+KymuWBD8uvInQdad8k4MEVj7fpVqHDSj7DzbHcZppKI2jT8dOoXJMrIodgA2e8hN2UYE/3WbsP7u/widDFvTDDKjXtAKuf4SOPlbA8WmnKeVBvcP8cro0YZ2sjSz0B0zPVsylUGF7a7peP8PJFl+X+gm4Z04PN2jQbD3ZcjAJPUMXtVT7LmvU8yIB5R3DmyofmrYY7X0V/QgPMjXWm04jmuJ1ijgrR8YfYm1NBCgxLOPH7Qbc5AAGTP0kDCC7fK5UFJRdVofh0WPp5/veyfhgYr6gA0U53kGDgUNrHY0MntZd4mc4EpwacLrcx3MfKq2EqFtuNYT+pWnIXRnIaNirOVpfWV9zzfGIKIyP9FM+IjFL2KjOv&Destination=https%3A%2F%2Fus-west-2.console.aws.amazon.com%2Frds%2Fhome%3Fregion%3Dus-west-2%23dbinstance%3Aid%3Drds-f49a3e3f9e%3Bview%3Dlogs"
          }
            
          








Get a database service's events URL

GET /database-services/:database_service/events

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=GjxY03jOmxp2i/sVSgqRI5bjlCOknXqsUuMTeh1hYDpKUjCkvUqEPuDMz6ewlBUJj/ZLu/QrEWuiiptWqTJu8dHje1i6K/KduiAzz4Vln11CdiP2lxzSnhjKIz/nTFsyaqB3UfBo/GZFO5hXWqabC2nbZmXT2JrP75yD0BF+RHW+IKqn1rDSBkOFDz9e9GI0zIAuMYAxqD/z1eXETekI1OpwlHOoKWs13Nqi0r2G/zf+kxYzM9zKAsSBWry1ffpa2Va5n+h8SpGaZzEncIhI6pJ6wBKMR5dvc4EHpk7DZNTynEEot6N/Wt+1qisRIcB2tZExkxZhCZea0eFGqt57j+vM9r6+NVWK5Tn3/0sGn79B0cRl1Y08H84oZ0/ZneFbF6dTtMTg8wdSujhOLfperPu3tEJp5Dq1Ixk05WtnetGqSm/KXdU8SuGzW3TMIqbrMDQ5g+gS8iOjUJnB3E+I9TDQgc9zT7IcMOckwFAU9hl/6OtVoOghx8U4Wn/Zc51Ko9apK8PfPjAeyIe7W/wsrB3Ll0xPHo9p3NXFK7uUClilIBEilMejs8RaPGiwiy4ApVTEOCOqUX1r/Z+7rrnhdGk+FuNCkIj7x5MddPzKF9KR/EUMN6DFhGjr47lzPbBdqxaEhNqxVCyObQgzm99E5nl8CyTNqHWNHS5Je6zcEaau091CMvQpesv6plzBptB5aGPsC6gKHYGp5KQ8av6aaL3DWvJAc7mg68HcDiQcMLE7/nlH&Destination=https%3A%2F%2Fus-west-2.console.aws.amazon.com%2Frds%2Fhome%3Fregion%3Dus-west-2%23events%3A"
          }
            
          








Get a database service's metrics URL

GET /database-services/:database_service/metrics

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=SMB81EOWdXSesACPD1+J/gC9527wg9IE/Hqsp9TMUdaPwlgNIKi6194KAXo6Z6Hpa1L3TMDI2R5QlyDp4dKXthSRR4EdhQuvkwH32CZ/+qBjG8OR6kQUDRNrmJuuD/ia+jykqzHjiHSVJwbbIJ95D6WomRYLYPk9IFlfrz50OA3xYqwNI0owepEYxK4WOe8awIdhsWFZRRZWTr3O7rVyJBTMj1lIvAnJMDi3mKgxgZX1c+gYUY/kgD/OUt7a0UGQzCYWFuYsWOIES0VGKbWWZtqcWh771ujc+ufmRBGCtScJ4nGu3mDmLeHOkn/JdL02w6ANjebjRjZp9j4aw2pqa1qqzVe8Jv7XEVgZAq0RuUhzYBvX/qcuammKkIjPIRUwUwi4GnIhKH56lRKxM78jZV3myCSS99jv1jqcUu9ElZ0jZ2i8XNAwKdYeDFyM3F88pe8czJNtP7ioYU0sXS80Nidc/CZQD333gTjf7cQ2G93iwYlYqXvyC1aIHyGP87RfjDH5h1iI/D5U2S0d5Nric0HviUpAvA8WH+Lh5P4CQFiErZFUFdqTtd27BzD9m0GWb1U+jscBsCv2BLx/XFxgTZQFckHw5MWvHJP5fJcFvJ/nOFjbTxOYItqUZvB2Bb6dqsUzlEYZd39zWU/Ll0NVN+vBbR0/RNQmVxpsRqLvftZKy+qGN/7+TsWEefmE8fCwsjF4QfFINgWq4ZnyOk5DknWC/cgD/vVk1271gZeL/NuTt4GY&Destination=https%3A%2F%2Fus-west-2.console.aws.amazon.com%2Frds%2Fhome%3Fregion%3Dus-west-2%23dbinstances%3Aid%3Drds-0dcfecc8eb%3Bsf%3Dall%3Bv%3Dmm"
          }
            
          








Get a database service

GET /database-services/:database_service

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "database_service": {
              "id": "5069da05-268a-4f23-8308-8c17791cb8e1",
              "alerts": "https://api.engineyard.com/database-services/5069da05-268a-4f23-8308-8c17791cb8e1/alerts",
              "created_at": "2017-10-10T15:53:07+00:00",
              "databases": "https://api.engineyard.com/database-services/5069da05-268a-4f23-8308-8c17791cb8e1/databases",
              "deleted_at": null,
              "email_alert_level": 2,
              "engine": "mysql",
              "location": "us-east-1",
              "messages": "https://api.engineyard.com/database-services/5069da05-268a-4f23-8308-8c17791cb8e1/messages",
              "name": "282abf",
              "network": null,
              "notes": null,
              "password": "54df55363cc1",
              "provider": "https://api.engineyard.com/providers/153",
              "requests": "https://api.engineyard.com/database-services/5069da05-268a-4f23-8308-8c17791cb8e1/requests",
              "servers": "https://api.engineyard.com/database-services/5069da05-268a-4f23-8308-8c17791cb8e1/servers",
              "service_level": "level-1",
              "service_plan": "https://api.engineyard.com/database-services/5069da05-268a-4f23-8308-8c17791cb8e1/service_plans/53c9b5c6-26cd-4074-85fe-e560642f690d",
              "snapshots": "https://api.engineyard.com/database-services/5069da05-268a-4f23-8308-8c17791cb8e1/snapshots",
              "updated_at": "2017-10-10T15:53:07+00:00",
              "username": "ey_admin",
              "version": "5.6.23",
              "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=5069da05-268a-4f23-8308-8c17791cb8e1&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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "database_servers": [
              {
                "id": "eb43eb72-3127-41b4-8353-5402190a70f5",
                "alerts": "https://api.engineyard.com/database-servers/eb43eb72-3127-41b4-8353-5402190a70f5/alerts",
                "created_at": "2017-10-10T15:53:02+00:00",
                "database_service": "https://api.engineyard.com/database-services/f6ffb4d1-1673-437d-a731-06a6dd7b4b8a",
                "deleted_at": null,
                "endpoint": "mysql://rds-358ff96d31.xhysmdeo.us-west-2.rds.amazonaws.com:5432",
                "engine": "mysql",
                "firewalls": "https://api.engineyard.com/database-servers/eb43eb72-3127-41b4-8353-5402190a70f5/firewalls",
                "flavor": "db.m3.large",
                "location": "us-west-2a",
                "messages": "https://api.engineyard.com/database-servers/eb43eb72-3127-41b4-8353-5402190a70f5/messages",
                "modifiers": {
                  "storage_type": "gp2"
                },
                "network": null,
                "password": "6befe21f8168",
                "provider": "https://api.engineyard.com/providers/152",
                "provisioned_id": "rds-358ff96d31",
                "revisions": "https://api.engineyard.com/database-servers/eb43eb72-3127-41b4-8353-5402190a70f5/revisions",
                "replication_source": null,
                "snapshots": "https://api.engineyard.com/database-servers/eb43eb72-3127-41b4-8353-5402190a70f5/snapshots",
                "storage": 100,
                "updated_at": "2017-10-10T15:53:02+00:00",
                "username": "ey_admin",
                "version": "5.6.34",
                "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

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "messages": [
              {
                "id": "f0356de2-cc97-456e-ae89-d864b514b3af",
                "created_at": "2017-10-10T15:53:12+00:00",
                "message": "Officia velit quo architecto accusantium vel et eveniet.",
                "type": null,
                "resource": null,
                "stage": null
              }
            ]
          }
            
          








List all database services on a specific provider

GET /providers/:provider_id/database-services

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "database_services": [
              {
                "id": "2609489a-c5ec-427c-8c3e-d9e852e542ed",
                "alerts": "https://api.engineyard.com/database-services/2609489a-c5ec-427c-8c3e-d9e852e542ed/alerts",
                "created_at": "2017-10-10T15:52:58+00:00",
                "databases": "https://api.engineyard.com/database-services/2609489a-c5ec-427c-8c3e-d9e852e542ed/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "aurora",
                "location": "us-west-2",
                "messages": "https://api.engineyard.com/database-services/2609489a-c5ec-427c-8c3e-d9e852e542ed/messages",
                "name": "9082c2",
                "network": null,
                "notes": null,
                "password": "369d001b13e6",
                "provider": "https://api.engineyard.com/providers/151",
                "requests": "https://api.engineyard.com/database-services/2609489a-c5ec-427c-8c3e-d9e852e542ed/requests",
                "servers": "https://api.engineyard.com/database-services/2609489a-c5ec-427c-8c3e-d9e852e542ed/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/2609489a-c5ec-427c-8c3e-d9e852e542ed/service_plans/1877c676-78da-4276-8da0-22b7be61bd24",
                "snapshots": "https://api.engineyard.com/database-services/2609489a-c5ec-427c-8c3e-d9e852e542ed/snapshots",
                "updated_at": "2017-10-10T15:52:58+00:00",
                "username": "ey_admin",
                "version": "5.6.10a",
                "db_engine_type": "aurora",
                "db_master_multi_az": null,
                "db_master_flavor": "db.r3.large",
                "db_replica_count": 0,
                "connected_kubey_cluster_count": 0,
                "connected_kubey_environments": "https://api.engineyard.com/environments?database_service_id=2609489a-c5ec-427c-8c3e-d9e852e542ed&kubey=true",
                "vpc_name": null,
                "vpc_provisioned_id": null
              },
              {
                "id": "2ea2c941-4d3d-446b-812d-8d8f53c61104",
                "alerts": "https://api.engineyard.com/database-services/2ea2c941-4d3d-446b-812d-8d8f53c61104/alerts",
                "created_at": "2017-10-10T15:52:55+00:00",
                "databases": "https://api.engineyard.com/database-services/2ea2c941-4d3d-446b-812d-8d8f53c61104/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "aurora",
                "location": "us-west-2",
                "messages": "https://api.engineyard.com/database-services/2ea2c941-4d3d-446b-812d-8d8f53c61104/messages",
                "name": "91dced",
                "network": null,
                "notes": null,
                "password": "5fd438e69029",
                "provider": "https://api.engineyard.com/providers/151",
                "requests": "https://api.engineyard.com/database-services/2ea2c941-4d3d-446b-812d-8d8f53c61104/requests",
                "servers": "https://api.engineyard.com/database-services/2ea2c941-4d3d-446b-812d-8d8f53c61104/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/2ea2c941-4d3d-446b-812d-8d8f53c61104/service_plans/de196b46-2de2-4b28-ab18-aeb741e02281",
                "snapshots": "https://api.engineyard.com/database-services/2ea2c941-4d3d-446b-812d-8d8f53c61104/snapshots",
                "updated_at": "2017-10-10T15:52:55+00:00",
                "username": "ey_admin",
                "version": "5.6.10a",
                "db_engine_type": "aurora",
                "db_master_multi_az": null,
                "db_master_flavor": "db.r3.large",
                "db_replica_count": 0,
                "connected_kubey_cluster_count": 0,
                "connected_kubey_environments": "https://api.engineyard.com/environments?database_service_id=2ea2c941-4d3d-446b-812d-8d8f53c61104&kubey=true",
                "vpc_name": null,
                "vpc_provisioned_id": null
              }
            ]
          }
            
          








List all database services on an account

GET /accounts/:account_id/database-services

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "database_services": [
              {
                "id": "7a50707c-bc04-44dd-b652-fa78e6b010e3",
                "alerts": "https://api.engineyard.com/database-services/7a50707c-bc04-44dd-b652-fa78e6b010e3/alerts",
                "created_at": "2017-10-10T15:52:51+00:00",
                "databases": "https://api.engineyard.com/database-services/7a50707c-bc04-44dd-b652-fa78e6b010e3/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "aurora",
                "location": "us-west-2",
                "messages": "https://api.engineyard.com/database-services/7a50707c-bc04-44dd-b652-fa78e6b010e3/messages",
                "name": "7170b5",
                "network": null,
                "notes": null,
                "password": "8641dfc371de",
                "provider": "https://api.engineyard.com/providers/150",
                "requests": "https://api.engineyard.com/database-services/7a50707c-bc04-44dd-b652-fa78e6b010e3/requests",
                "servers": "https://api.engineyard.com/database-services/7a50707c-bc04-44dd-b652-fa78e6b010e3/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/7a50707c-bc04-44dd-b652-fa78e6b010e3/service_plans/c30a3193-f686-442c-af29-4aed8c26e438",
                "snapshots": "https://api.engineyard.com/database-services/7a50707c-bc04-44dd-b652-fa78e6b010e3/snapshots",
                "updated_at": "2017-10-10T15:52:51+00:00",
                "username": "ey_admin",
                "version": "5.6.10a",
                "db_engine_type": "aurora",
                "db_master_multi_az": null,
                "db_master_flavor": "db.r3.large",
                "db_replica_count": 0,
                "connected_kubey_cluster_count": 0,
                "connected_kubey_environments": "https://api.engineyard.com/environments?database_service_id=7a50707c-bc04-44dd-b652-fa78e6b010e3&kubey=true",
                "vpc_name": null,
                "vpc_provisioned_id": null
              },
              {
                "id": "7c1bfe41-40a9-4ebc-a605-a448ad654dce",
                "alerts": "https://api.engineyard.com/database-services/7c1bfe41-40a9-4ebc-a605-a448ad654dce/alerts",
                "created_at": "2017-10-10T15:52:49+00:00",
                "databases": "https://api.engineyard.com/database-services/7c1bfe41-40a9-4ebc-a605-a448ad654dce/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "postgres",
                "location": "us-west-2",
                "messages": "https://api.engineyard.com/database-services/7c1bfe41-40a9-4ebc-a605-a448ad654dce/messages",
                "name": "fca582",
                "network": null,
                "notes": null,
                "password": "32e1cb97d9ca",
                "provider": "https://api.engineyard.com/providers/150",
                "requests": "https://api.engineyard.com/database-services/7c1bfe41-40a9-4ebc-a605-a448ad654dce/requests",
                "servers": "https://api.engineyard.com/database-services/7c1bfe41-40a9-4ebc-a605-a448ad654dce/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/7c1bfe41-40a9-4ebc-a605-a448ad654dce/service_plans/ccd2b515-d49a-493f-98cc-2a1a08679d3f",
                "snapshots": "https://api.engineyard.com/database-services/7c1bfe41-40a9-4ebc-a605-a448ad654dce/snapshots",
                "updated_at": "2017-10-10T15:52:49+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=7c1bfe41-40a9-4ebc-a605-a448ad654dce&kubey=true",
                "vpc_name": null,
                "vpc_provisioned_id": null
              }
            ]
          }
            
          








List database services

GET /database-services

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "database_services": [
              {
                "id": "3bc86ce7-0fa2-4188-bfd0-a0f3f643d24b",
                "alerts": "https://api.engineyard.com/database-services/3bc86ce7-0fa2-4188-bfd0-a0f3f643d24b/alerts",
                "created_at": "2017-10-10T15:52:44+00:00",
                "databases": "https://api.engineyard.com/database-services/3bc86ce7-0fa2-4188-bfd0-a0f3f643d24b/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "postgres",
                "location": "us-west-2",
                "messages": "https://api.engineyard.com/database-services/3bc86ce7-0fa2-4188-bfd0-a0f3f643d24b/messages",
                "name": "26dcc1",
                "network": null,
                "notes": null,
                "password": "52f7c03e91d1",
                "provider": "https://api.engineyard.com/providers/149",
                "requests": "https://api.engineyard.com/database-services/3bc86ce7-0fa2-4188-bfd0-a0f3f643d24b/requests",
                "servers": "https://api.engineyard.com/database-services/3bc86ce7-0fa2-4188-bfd0-a0f3f643d24b/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/3bc86ce7-0fa2-4188-bfd0-a0f3f643d24b/service_plans/dc50bcff-c5a3-42bf-bb2a-b027f0611eac",
                "snapshots": "https://api.engineyard.com/database-services/3bc86ce7-0fa2-4188-bfd0-a0f3f643d24b/snapshots",
                "updated_at": "2017-10-10T15:52:44+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=3bc86ce7-0fa2-4188-bfd0-a0f3f643d24b&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": "764828c82b"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "update_database_service",
              "id": "2c1f503b-88e1-4d2c-9040-ab05532e7bf8",
              "created_at": "2017-10-10T15:52:40+00:00",
              "started_at": "2017-10-10T15:52:40+00:00",
              "finished_at": "2017-10-10T15:52:40+00:00",
              "message": null,
              "request_status": "Finished: Update database service (2c1f503b-88e1-4d2c-9040-ab05532e7bf8) (less than a minute ago)",
              "successful": true,
              "updated_at": "2017-10-10T15:52:40+00:00",
              "read_channel": null,
              "stage": "update",
              "dependencies": "https://api.engineyard.com/requests/2c1f503b-88e1-4d2c-9040-ab05532e7bf8/dependencies",
              "stages": "https://api.engineyard.com/requests/2c1f503b-88e1-4d2c-9040-ab05532e7bf8/stages",
              "account": "https://api.engineyard.com/accounts/3a14bcce-746e-4671-903b-156add06b2c2",
              "requester": "https://api.engineyard.com/requests/2c1f503b-88e1-4d2c-9040-ab05532e7bf8/requester",
              "messages": "https://api.engineyard.com/requests/2c1f503b-88e1-4d2c-9040-ab05532e7bf8/messages",
              "callback_url": "https://api.engineyard.com/requests/2c1f503b-88e1-4d2c-9040-ab05532e7bf8/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/database-services/bd6ecaca-f1d0-44cf-972f-8bab72783c72"
            }
          }