Database Services

Database services API

Create a database service
Create a database service in a network
Deprovision a database service
Get a database master's logs URL
Get a database replica's logs URL
Get a database service's events URL
Get a database service's metrics URL
Get a database service
Get database services servers
List a database service's messages
List all database services on a specific provider
List all database services on an account
List database services
Updates a provisioned database service

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": "Aut quibusdam et labore quo voluptatem non in dolorem."
            },
            "database_server": {
              "flavor": "db.m3.large",
              "engine": "postgres",
              "version": "9.4.11",
              "location": "us-west-2b",
              "storage": 50,
              "modifiers": {
                "multi_az": true
              }
            }
          }

Response

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

            
          {
            "request": {
              "type": "provision_database_service",
              "id": "bf4c52f4-6a82-4052-991d-bc9acb216ded",
              "created_at": "2018-05-29T10:59:04+00:00",
              "started_at": "2018-05-29T10:59:04+00:00",
              "finished_at": "2018-05-29T10:59:07+00:00",
              "message": null,
              "request_status": "Finished: Provision database service (bf4c52f4-6a82-4052-991d-bc9acb216ded) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:59:07+00:00",
              "read_channel": null,
              "stage": "create-provider-credentials",
              "dependencies": "https://api.engineyard.com/requests/bf4c52f4-6a82-4052-991d-bc9acb216ded/dependencies",
              "stages": "https://api.engineyard.com/requests/bf4c52f4-6a82-4052-991d-bc9acb216ded/stages",
              "account": "https://api.engineyard.com/accounts/3be30f20-85cf-4f29-ae4d-2f5252e9c241",
              "requester": "https://api.engineyard.com/requests/bf4c52f4-6a82-4052-991d-bc9acb216ded/requester",
              "messages": "https://api.engineyard.com/requests/bf4c52f4-6a82-4052-991d-bc9acb216ded/messages",
              "callback_url": "https://api.engineyard.com/requests/bf4c52f4-6a82-4052-991d-bc9acb216ded/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/database-services/70ebf50a-56ff-45e7-b2ea-4e259b3ff876"
            }
          }

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": "84a86066-f495-4a02-bbde-027865bfec98",
            "database_service": {
              "name": "my-database-server",
              "service_level": "level-1",
              "notes": "Dolor ab quia in vero est quasi ut."
            },
            "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": "cdee29c3-f02a-4dd5-864d-a53a4ba4caab",
              "created_at": "2018-05-29T10:59:13+00:00",
              "started_at": "2018-05-29T10:59:13+00:00",
              "finished_at": "2018-05-29T10:59:16+00:00",
              "message": null,
              "request_status": "Finished: Provision database service (cdee29c3-f02a-4dd5-864d-a53a4ba4caab) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:59:16+00:00",
              "read_channel": null,
              "stage": "create-provider-credentials",
              "dependencies": "https://api.engineyard.com/requests/cdee29c3-f02a-4dd5-864d-a53a4ba4caab/dependencies",
              "stages": "https://api.engineyard.com/requests/cdee29c3-f02a-4dd5-864d-a53a4ba4caab/stages",
              "account": "https://api.engineyard.com/accounts/97a54413-7e4f-406d-8fc2-a5125b650765",
              "requester": "https://api.engineyard.com/requests/cdee29c3-f02a-4dd5-864d-a53a4ba4caab/requester",
              "messages": "https://api.engineyard.com/requests/cdee29c3-f02a-4dd5-864d-a53a4ba4caab/messages",
              "callback_url": "https://api.engineyard.com/requests/cdee29c3-f02a-4dd5-864d-a53a4ba4caab/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/database-services/57635856-2a5b-49d0-aa6d-37c92d231a12"
            }
          }

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": "a73c908f-bcf1-4a04-89d0-e572e99e4241",
              "created_at": "2018-05-29T11:00:30+00:00",
              "started_at": "2018-05-29T11:00:30+00:00",
              "finished_at": "2018-05-29T11:00:32+00:00",
              "message": null,
              "request_status": "Finished: Deprovision database service (a73c908f-bcf1-4a04-89d0-e572e99e4241) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T11:00:32+00:00",
              "read_channel": null,
              "stage": "destroy",
              "dependencies": "https://api.engineyard.com/requests/a73c908f-bcf1-4a04-89d0-e572e99e4241/dependencies",
              "stages": "https://api.engineyard.com/requests/a73c908f-bcf1-4a04-89d0-e572e99e4241/stages",
              "account": "https://api.engineyard.com/accounts/efffd97a-597d-492c-9912-303f9c5bb94f",
              "requester": "https://api.engineyard.com/requests/a73c908f-bcf1-4a04-89d0-e572e99e4241/requester",
              "messages": "https://api.engineyard.com/requests/a73c908f-bcf1-4a04-89d0-e572e99e4241/messages",
              "callback_url": "https://api.engineyard.com/requests/a73c908f-bcf1-4a04-89d0-e572e99e4241/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/database-services/0a5eaec8-fe4b-42b8-a5d1-318b04f0e93f"
            }
          }

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=6cabDudZvHjPuZKb2jGuqSsRU7+dPdfDRfNI+SZFBXP3w5wVRFRw0h7dP1kVfP+c0zocNFtcZwPxFEqeYpIwvXO6pPRz6KsDVX+9K3BMQj43bJyeEZTBRZDkXnMG/cxqpUl5OsHri14h61g1sxAGn540NbCMeQ9ZQy5wkmLYglQUyXAnhaGGWnjcSi/TrAo38JTDEsKtvS3GIxNhvAIL/WNnLGkPMKZUA061jLeF2xJ243GQ3e5Xj3+IOIGX7H+A/21tYWSxF1qPzWs2v3gfj5wuI76F171iGrqRiD5qCH9VIzgsa4c352bTIk0/+0/xq234CLguZz4cJHQupk3JQ6AIG1zPSPH6C/+zIZ4hIDxowWU5CLYScAs3jGy37OLKXqI/yDT+tUdMQiwxXX+ARjmRr6nJGFWjpXPf95fD5Ok98VG/soFh7fB0jF/VtVp3wJhC5q5j3iUXamgzk/B78OYk503K1naOrUd3Z0GInNv7jsEhsG+/0KhsZcSFIOOVL2GBt895hXMCRXKo5gnAygJiNNOcYtg/PX7luK+goR2iilBQza8KOgt5Jzi18L8E1F+FhoZ8zo+NAzVjMmasql0U+hyA/YzEqCWIzbBf55LG73OyhMPliy1EGkkQQpxLsD/0ZCMBNxumKUfaVFYpmVhCu12jQF2ltdmEBCeXRBLkTOjThn0wCzlnYDARrJoAgsQlvj0QKMfOvTOffXBSdEuvz38XYfdtDAXYs+WI1jH2HD7b&Destination=https%3A%2F%2Fus-west-2.console.aws.amazon.com%2Frds%2Fhome%3Fregion%3Dus-west-2%23dbinstance%3Aid%3Drds-5f42edb0c2%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=eAV+AvLbCkw/eBforpRQzYfmrNgm6o56q2OBEyhV1KKBJkrMwYftYCNTMS+EE89l5logOu1vKGa9bvsTC2uS9Q5I9DRGJIUPv1Oy0oiaD3XbaAhd8XS1GEMFfOXhDILOVfZw0A1ziT81sPwLu9audgclmpg9lDF/C2Ly+TgPGkuyPqrQxlUTysJHt3Z7IDncseo3vVqfm68q+EKeU8eXDQRqFHQeKhodetuCGxUsdVZY3WHgqAcB6tPucoxmBIS4gI6zcCYjLtTzIq7FXnM69oztYFPOY7Qz5i0sWX3gMrW4o5LCq4p79r1diJ0KwU6xH3n+A6CPi7aqTl8PZlTeEF8vEVbczZRi2nq1+iBhOwnp74Lvu4SoAxLw2yngHxY4MXaF+jgPKDXke8z2wb23UP2kSgfZAMf1mzOkBvICNhVrz2gGo29eKWNELWZscCQ/jYJ0XNdE1A40oCNarKoyeDQhqpWzNczu8rRMQ+8RQ+DqwxTZNp6BgA8vRgMtHE4/8GCWhF0ugT7oDJg1NPm8/5rg78NNUVp36ZejqBy9q/P4feoZCu0sw1I7zl3vFxI2Obf8L6a7IxAzP7fYdp4xX3YwFTJH6yCYjRA9f1etygXNKQsfx/ZVSj8p15v63sjI90n1xkB5CS9VMd1GiC8Ge93TIEFT2v3TviB9IxhMrDyCYSmGuqeIlDVuU5ct+HgLWG71KkxaIr6qdzVAzRM5wnoaI5I0Ax+6x4grzUBWKsq9nj1M&Destination=https%3A%2F%2Fus-east-1.console.aws.amazon.com%2Frds%2Fhome%3Fregion%3Dus-east-1%23dbinstance%3Aid%3Drds-4a9a2f94cb%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=I9mwefq8moipQ2H9VH6FzIW3UV/62/AyVXfr2i5YuXIRjIjsxcBirNzjxYlUCMRMwxzv4IveSDMbLcH0vcYOjJZUt7cg4fB1xsNStEGdwuWnGoniyFOWWG7GphT/K6YS6YGZgr1tPFTtyd+forr4xeRN1KoGDavZd5UpG1h5oqVF9pcTbcWNu15Ta6KHQPMUE1G64vgMxaL2XsbrnfjBT6Z/K4G4THqF5/TRdxsO+lOHf8ZaDkE2sIi0a2PWMDNgky9v7qobuz1ltdrfn+sb8OgZBEnG4gv3Q22Tza63HcBG8YnWl7nE1Chhr5wqLUFBjz9QOIGtRwottasqtxXJMg0bgcI+iJiK65taGN+52tVJnf6hCNNGPH/fQPDRZPEvrRub62O/BBBprR+5+08UJ7O/Yhpc+AXfjLyZc2ejcpfN3qZDVdPhD/z74Kh2HRM2Gm8cxffgyxJeTjJ8xyUPZUBelxf5pVq+UOxVydAdpUEPz+qiCJOrui0Ert0toJf4h6rC6wNxqns76b0o4H5Aff+aLeDVkeRPWtIy7h/nbPRJURBq5YT5XC0c9GA2QT8vAAJV8R/k0Y73iy7FPLLKVZDCq/xH5vPGLPxryWl1tOQr1cHr3PFKmnpJYVRGK3tuQo9LBOE9jrel1DsSloPZVnfjtABQVL4oRGIfcpE818SLQQX8uFkcC0J2xZa/IrizZuykYs9hHEno9kgm6sXlN3N+Z/7Fe0H7MMLEed5n0uTyKkMQ&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=KAdlZ7/ptc0QjtxlkQDEvGhZrFAj+5LtW2qWWYto9fx24bmgTDtAbQhkiPzw102+lGnzCkX75zkyMIecLzKOKjJudZEHUrnqSfTtsUb1twO/HThY0Oo06BiVoVsJfPVwlkEAxto3WuwZDdFDIozs5MTJOTnlz1BWMYAQgRMzvRgmnL2LsCk9j/DRdklFcZNlppGC+tbdnuNXMmgE2y8jyYoffKvT3/1Sk6t1FDiUSE2Ksn2w3zECKaQmqFx8VVzIbWX5FTdJjVbguUTW1bzKge46eGa/rLYTaqsAawNNLpD40nxL2wakD4dtxs6pTkMh9KNmdpIN2aEcO+CFHgs+R+jtaT6e5rSVU/ueUY7Bln0tLSiFflh+DytT43kKlPnDdDzvlwrjEN0r7kZyfoBa0DXspn0EUfNAmLIxTZDp/7d+XlLpIXS3JIpGqQ4ZvEvL3JfjxoxKnEVNhhVdy3K3VsjGFYavf165+qDuMVsuFx3stk5e+gKDLRFHAuq4ako2fvizRvubZ2qXaMS05nPyOtEpzwFCjO7rsCcHkQ5AKDu2a6nl18XwXKty99gUwvbDVk4UH1e1xoxS4DQLqm4tk5tz4aSnBnDBmJYifHNRTJEMbCh/8mmOI0qcb60uWv72n6VhgcU0o3guUHnCsOKg/k5cg1PY9d8QJ4vxJTT3ZIv5So28stc4X3iPzTFOwiExicsB/Llr7yKuDuR5n1zjpJlnfHOyzvM85mucjbdSHF3ZeMle&Destination=https%3A%2F%2Fus-west-2.console.aws.amazon.com%2Frds%2Fhome%3Fregion%3Dus-west-2%23dbinstances%3Aid%3Drds-ae0bb443bd%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": "fc6ab383-0d2c-478c-9762-68871e257007",
              "alerts": "https://api.engineyard.com/database-services/fc6ab383-0d2c-478c-9762-68871e257007/alerts",
              "created_at": "2018-05-29T10:59:55+00:00",
              "databases": "https://api.engineyard.com/database-services/fc6ab383-0d2c-478c-9762-68871e257007/databases",
              "deleted_at": null,
              "email_alert_level": 2,
              "engine": "aurora",
              "location": "us-west-2",
              "messages": "https://api.engineyard.com/database-services/fc6ab383-0d2c-478c-9762-68871e257007/messages",
              "name": "1f8644",
              "network": null,
              "notes": null,
              "password": "6c8b26cba5e8",
              "provider": "https://api.engineyard.com/providers/153",
              "requests": "https://api.engineyard.com/database-services/fc6ab383-0d2c-478c-9762-68871e257007/requests",
              "servers": "https://api.engineyard.com/database-services/fc6ab383-0d2c-478c-9762-68871e257007/servers",
              "service_level": "level-1",
              "service_plan": "https://api.engineyard.com/database-services/fc6ab383-0d2c-478c-9762-68871e257007/service_plans/a93d6651-6855-4a41-b536-ffc83d594279",
              "snapshots": "https://api.engineyard.com/database-services/fc6ab383-0d2c-478c-9762-68871e257007/snapshots",
              "updated_at": "2018-05-29T10:59:55+00:00",
              "username": "ey_admin",
              "version": "5.6.10a",
              "db_engine_type": "aurora",
              "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=fc6ab383-0d2c-478c-9762-68871e257007&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": "3c241ec4-3514-4ac2-9780-2b648676b539",
                "alerts": "https://api.engineyard.com/database-servers/3c241ec4-3514-4ac2-9780-2b648676b539/alerts",
                "created_at": "2018-05-29T10:59:49+00:00",
                "database_service": "https://api.engineyard.com/database-services/cd14968a-debb-4519-8db3-739ff6fef9bf",
                "deleted_at": null,
                "endpoint": "aurora://rds-5138ee1543.yhyspxwo.us-east-1.rds.amazonaws.com:5432",
                "engine": "aurora",
                "firewalls": "https://api.engineyard.com/database-servers/3c241ec4-3514-4ac2-9780-2b648676b539/firewalls",
                "flavor": "db.m3.large",
                "location": "us-east-1e",
                "messages": "https://api.engineyard.com/database-servers/3c241ec4-3514-4ac2-9780-2b648676b539/messages",
                "modifiers": {
                  "storage_type": "aurora"
                },
                "network": null,
                "password": "d2ba0bf95b5d",
                "provider": "https://api.engineyard.com/providers/152",
                "provisioned_id": "rds-5138ee1543",
                "revisions": "https://api.engineyard.com/database-servers/3c241ec4-3514-4ac2-9780-2b648676b539/revisions",
                "replication_source": null,
                "snapshots": "https://api.engineyard.com/database-servers/3c241ec4-3514-4ac2-9780-2b648676b539/snapshots",
                "storage": 100,
                "updated_at": "2018-05-29T10:59:49+00:00",
                "username": "ey_admin",
                "version": "5.6.10a",
                "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": "aurora",
                "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": "85b250e9-6863-4a6e-b80e-594e4878c6bc",
                "created_at": "2018-05-29T11:00:01+00:00",
                "message": "Eligendi ut in ullam.",
                "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": "b82a4e3e-320a-4727-a99c-f76e8b7dc258",
                "alerts": "https://api.engineyard.com/database-services/b82a4e3e-320a-4727-a99c-f76e8b7dc258/alerts",
                "created_at": "2018-05-29T10:59:43+00:00",
                "databases": "https://api.engineyard.com/database-services/b82a4e3e-320a-4727-a99c-f76e8b7dc258/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "aurora",
                "location": "us-east-1",
                "messages": "https://api.engineyard.com/database-services/b82a4e3e-320a-4727-a99c-f76e8b7dc258/messages",
                "name": "3d8d6a",
                "network": null,
                "notes": null,
                "password": "e98624ffbdab",
                "provider": "https://api.engineyard.com/providers/151",
                "requests": "https://api.engineyard.com/database-services/b82a4e3e-320a-4727-a99c-f76e8b7dc258/requests",
                "servers": "https://api.engineyard.com/database-services/b82a4e3e-320a-4727-a99c-f76e8b7dc258/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/b82a4e3e-320a-4727-a99c-f76e8b7dc258/service_plans/1ae6a5d0-048e-4eb6-9983-afddbc617099",
                "snapshots": "https://api.engineyard.com/database-services/b82a4e3e-320a-4727-a99c-f76e8b7dc258/snapshots",
                "updated_at": "2018-05-29T10:59:44+00:00",
                "username": "ey_admin",
                "version": "5.6.10a",
                "db_engine_type": "aurora",
                "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=b82a4e3e-320a-4727-a99c-f76e8b7dc258&kubey=true",
                "vpc_name": null,
                "vpc_provisioned_id": null
              },
              {
                "id": "c827f6e0-4956-49f7-b274-b80ec01eefc5",
                "alerts": "https://api.engineyard.com/database-services/c827f6e0-4956-49f7-b274-b80ec01eefc5/alerts",
                "created_at": "2018-05-29T10:59:40+00:00",
                "databases": "https://api.engineyard.com/database-services/c827f6e0-4956-49f7-b274-b80ec01eefc5/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "aurora",
                "location": "us-east-1",
                "messages": "https://api.engineyard.com/database-services/c827f6e0-4956-49f7-b274-b80ec01eefc5/messages",
                "name": "335d06",
                "network": null,
                "notes": null,
                "password": "3758e1350bc3",
                "provider": "https://api.engineyard.com/providers/151",
                "requests": "https://api.engineyard.com/database-services/c827f6e0-4956-49f7-b274-b80ec01eefc5/requests",
                "servers": "https://api.engineyard.com/database-services/c827f6e0-4956-49f7-b274-b80ec01eefc5/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/c827f6e0-4956-49f7-b274-b80ec01eefc5/service_plans/96706c9d-524f-4381-af17-b296f373b62f",
                "snapshots": "https://api.engineyard.com/database-services/c827f6e0-4956-49f7-b274-b80ec01eefc5/snapshots",
                "updated_at": "2018-05-29T10:59:40+00:00",
                "username": "ey_admin",
                "version": "5.6.10a",
                "db_engine_type": "aurora",
                "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=c827f6e0-4956-49f7-b274-b80ec01eefc5&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": "714e9f87-dd9a-49bd-ab18-93ca3db6c76f",
                "alerts": "https://api.engineyard.com/database-services/714e9f87-dd9a-49bd-ab18-93ca3db6c76f/alerts",
                "created_at": "2018-05-29T10:59:35+00:00",
                "databases": "https://api.engineyard.com/database-services/714e9f87-dd9a-49bd-ab18-93ca3db6c76f/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "mysql",
                "location": "us-east-1",
                "messages": "https://api.engineyard.com/database-services/714e9f87-dd9a-49bd-ab18-93ca3db6c76f/messages",
                "name": "09642a",
                "network": null,
                "notes": null,
                "password": "be172dcbc401",
                "provider": "https://api.engineyard.com/providers/150",
                "requests": "https://api.engineyard.com/database-services/714e9f87-dd9a-49bd-ab18-93ca3db6c76f/requests",
                "servers": "https://api.engineyard.com/database-services/714e9f87-dd9a-49bd-ab18-93ca3db6c76f/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/714e9f87-dd9a-49bd-ab18-93ca3db6c76f/service_plans/bd3be221-2ed7-43e4-a37e-5b5b1dde8c21",
                "snapshots": "https://api.engineyard.com/database-services/714e9f87-dd9a-49bd-ab18-93ca3db6c76f/snapshots",
                "updated_at": "2018-05-29T10:59:35+00:00",
                "username": "ey_admin",
                "version": "5.7.17",
                "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=714e9f87-dd9a-49bd-ab18-93ca3db6c76f&kubey=true",
                "vpc_name": null,
                "vpc_provisioned_id": null
              },
              {
                "id": "f8ea8f83-a099-42e4-8977-880efc228dcc",
                "alerts": "https://api.engineyard.com/database-services/f8ea8f83-a099-42e4-8977-880efc228dcc/alerts",
                "created_at": "2018-05-29T10:59:32+00:00",
                "databases": "https://api.engineyard.com/database-services/f8ea8f83-a099-42e4-8977-880efc228dcc/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "aurora",
                "location": "us-east-1",
                "messages": "https://api.engineyard.com/database-services/f8ea8f83-a099-42e4-8977-880efc228dcc/messages",
                "name": "f3acff",
                "network": null,
                "notes": null,
                "password": "eab44aa8cba8",
                "provider": "https://api.engineyard.com/providers/150",
                "requests": "https://api.engineyard.com/database-services/f8ea8f83-a099-42e4-8977-880efc228dcc/requests",
                "servers": "https://api.engineyard.com/database-services/f8ea8f83-a099-42e4-8977-880efc228dcc/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/f8ea8f83-a099-42e4-8977-880efc228dcc/service_plans/2c2770a3-952e-4f71-b94b-772a9821b5a8",
                "snapshots": "https://api.engineyard.com/database-services/f8ea8f83-a099-42e4-8977-880efc228dcc/snapshots",
                "updated_at": "2018-05-29T10:59:32+00:00",
                "username": "ey_admin",
                "version": "5.6.10a",
                "db_engine_type": "aurora",
                "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=f8ea8f83-a099-42e4-8977-880efc228dcc&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": "2a64e847-ab33-47bf-96e9-fd263a58b062",
                "alerts": "https://api.engineyard.com/database-services/2a64e847-ab33-47bf-96e9-fd263a58b062/alerts",
                "created_at": "2018-05-29T10:59:26+00:00",
                "databases": "https://api.engineyard.com/database-services/2a64e847-ab33-47bf-96e9-fd263a58b062/databases",
                "deleted_at": null,
                "email_alert_level": 2,
                "engine": "postgres",
                "location": "us-west-2",
                "messages": "https://api.engineyard.com/database-services/2a64e847-ab33-47bf-96e9-fd263a58b062/messages",
                "name": "0df32a",
                "network": null,
                "notes": null,
                "password": "dbde2d6ffbf0",
                "provider": "https://api.engineyard.com/providers/149",
                "requests": "https://api.engineyard.com/database-services/2a64e847-ab33-47bf-96e9-fd263a58b062/requests",
                "servers": "https://api.engineyard.com/database-services/2a64e847-ab33-47bf-96e9-fd263a58b062/servers",
                "service_level": "level-1",
                "service_plan": "https://api.engineyard.com/database-services/2a64e847-ab33-47bf-96e9-fd263a58b062/service_plans/bc8a250a-9c11-4280-b2bf-567acd638cf4",
                "snapshots": "https://api.engineyard.com/database-services/2a64e847-ab33-47bf-96e9-fd263a58b062/snapshots",
                "updated_at": "2018-05-29T10:59:27+00:00",
                "username": "ey_admin",
                "version": "9.4.11",
                "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=2a64e847-ab33-47bf-96e9-fd263a58b062&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": "a7a6743dd1"
            }
          }

Response

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

            
          {
            "request": {
              "type": "update_database_service",
              "id": "7bcee258-ecd0-4995-99e2-2622585be3f9",
              "created_at": "2018-05-29T10:59:21+00:00",
              "started_at": "2018-05-29T10:59:22+00:00",
              "finished_at": "2018-05-29T10:59:22+00:00",
              "message": null,
              "request_status": "Finished: Update database service (7bcee258-ecd0-4995-99e2-2622585be3f9) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:59:22+00:00",
              "read_channel": null,
              "stage": "update",
              "dependencies": "https://api.engineyard.com/requests/7bcee258-ecd0-4995-99e2-2622585be3f9/dependencies",
              "stages": "https://api.engineyard.com/requests/7bcee258-ecd0-4995-99e2-2622585be3f9/stages",
              "account": "https://api.engineyard.com/accounts/07eabe31-fa97-42b2-9757-47423e6604cb",
              "requester": "https://api.engineyard.com/requests/7bcee258-ecd0-4995-99e2-2622585be3f9/requester",
              "messages": "https://api.engineyard.com/requests/7bcee258-ecd0-4995-99e2-2622585be3f9/messages",
              "callback_url": "https://api.engineyard.com/requests/7bcee258-ecd0-4995-99e2-2622585be3f9/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/database-services/8c6387a7-1fd9-43bf-bf35-6a013a7a376b"
            }
          }