Accounts API


List all accounts

GET /accounts

Parameters

name
required: false
Name of an account (fuzzy partial-name case-insensitive matching)
name_exactly
required: false
Name of an account (exact matching)
user_id
required: false
User ID of a User that belongs to an account
support_plan
required: false
Support plan of accounts
legacy_id
required: false
Support plan of accounts

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "accounts": [
              {
                "id": "457a86ec-9d02-421a-8cab-a09725c56226",
                "account_notes": "https://api.engineyard.com/accounts-notes.457a86ec-9d02-421a-8cab-a09725c56226",
                "account_trial": null,
                "addons": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/addons",
                "addresses": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/addresses",
                "applications": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/applications",
                "billable": true,
                "billing_required": false,
                "billing_signup_url": null,
                "canceled_at": null,
                "cancellation": null,
                "cancelled_at": null,
                "created_at": "2017-10-10T15:55:38+00:00",
                "database_services": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/database-services",
                "emergency_contact": null,
                "environments": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/environments",
                "features": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/features",
                "finalized": true,
                "logical_databases": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/logical-databases",
                "memberships": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/memberships",
                "name": "account-457a86ec-9d02-421a-8cab-a09725c56226",
                "owners": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/owners",
                "plan": null,
                "providers": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/providers",
                "rds_management_web_uri": "https://example.org/accounts/216/database_services",
                "referrals": null,
                "referrer_account": null,
                "requests": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/requests",
                "server_alerts": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/server-alerts",
                "signup_via": "classic",
                "ssl_certificates": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/ssl-certificates",
                "support_plan": "standard",
                "support_trial": null,
                "support_trial_status": "NA",
                "updated_at": "2017-10-10T15:55:38+00:00",
                "users": "https://api.engineyard.com/accounts/457a86ec-9d02-421a-8cab-a09725c56226/users"
              }
            ]
          }
            
          








List all accounts for a given user

GET /users/:user_id/accounts

Parameters

name
required: false
Name of an account
user_id
required: false
User ID of a User that belongs to an account
support_plan
required: false
Support plan of accounts
legacy_id
required: false
Support plan of accounts

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "accounts": [
              {
                "id": "b4d888ba-dd79-46e1-89c2-ce581b5a1aef",
                "account_notes": "https://api.engineyard.com/accounts-notes.b4d888ba-dd79-46e1-89c2-ce581b5a1aef",
                "account_trial": null,
                "addons": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/addons",
                "addresses": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/addresses",
                "applications": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/applications",
                "billable": true,
                "billing_required": false,
                "billing_signup_url": null,
                "canceled_at": null,
                "cancellation": null,
                "cancelled_at": null,
                "created_at": "2017-10-10T15:55:40+00:00",
                "database_services": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/database-services",
                "emergency_contact": null,
                "environments": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/environments",
                "features": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/features",
                "finalized": true,
                "logical_databases": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/logical-databases",
                "memberships": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/memberships",
                "name": "account-b4d888ba-dd79-46e1-89c2-ce581b5a1aef",
                "owners": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/owners",
                "plan": null,
                "providers": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/providers",
                "rds_management_web_uri": "https://example.org/accounts/217/database_services",
                "referrals": null,
                "referrer_account": null,
                "requests": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/requests",
                "server_alerts": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/server-alerts",
                "signup_via": "classic",
                "ssl_certificates": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/ssl-certificates",
                "support_plan": "standard",
                "support_trial": null,
                "support_trial_status": "NA",
                "updated_at": "2017-10-10T15:55:40+00:00",
                "users": "https://api.engineyard.com/accounts/b4d888ba-dd79-46e1-89c2-ce581b5a1aef/users"
              }
            ]
          }
            
          








Show an account

GET /accounts/:account_id

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "account": {
              "id": "0f976d9d-2254-4ba2-a90c-514c80269a81",
              "account_notes": "https://api.engineyard.com/accounts-notes.0f976d9d-2254-4ba2-a90c-514c80269a81",
              "account_trial": null,
              "addons": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/addons",
              "addresses": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/addresses",
              "applications": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/applications",
              "billable": true,
              "billing_required": false,
              "billing_signup_url": null,
              "canceled_at": null,
              "cancellation": null,
              "cancelled_at": null,
              "created_at": "2017-10-10T15:55:42+00:00",
              "database_services": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/database-services",
              "emergency_contact": null,
              "environments": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/environments",
              "features": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/features",
              "finalized": true,
              "logical_databases": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/logical-databases",
              "memberships": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/memberships",
              "name": "account-0f976d9d-2254-4ba2-a90c-514c80269a81",
              "owners": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/owners",
              "plan": null,
              "providers": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/providers",
              "rds_management_web_uri": "https://example.org/accounts/218/database_services",
              "referrals": null,
              "referrer_account": null,
              "requests": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/requests",
              "server_alerts": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/server-alerts",
              "signup_via": "classic",
              "ssl_certificates": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/ssl-certificates",
              "support_plan": "standard",
              "support_trial": null,
              "support_trial_status": "NA",
              "updated_at": "2017-10-10T15:55:43+00:00",
              "users": "https://api.engineyard.com/accounts/0f976d9d-2254-4ba2-a90c-514c80269a81/users"
            }
          }
            
          








Update account's emergency contact

PUT /accounts/:account_id

Parameters

name
required: false
scope: account
Name of the account
emergency_contact
required: false
scope: account
My Emergency Contact

Request

          Accept: application/json
          Content-Type: application/json
          
            
          {
            "account": {
              "emergency_contact": "My New Emergency Contact"
            }
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "account": {
              "id": "e01909ed-c9b5-48b1-9238-31bc93e9247d",
              "account_notes": "https://api.engineyard.com/accounts-notes.e01909ed-c9b5-48b1-9238-31bc93e9247d",
              "account_trial": null,
              "addons": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/addons",
              "addresses": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/addresses",
              "applications": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/applications",
              "billable": true,
              "billing_required": false,
              "billing_signup_url": null,
              "canceled_at": null,
              "cancellation": null,
              "cancelled_at": null,
              "created_at": "2017-10-10T15:55:45+00:00",
              "database_services": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/database-services",
              "emergency_contact": "My New Emergency Contact",
              "environments": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/environments",
              "features": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/features",
              "finalized": true,
              "logical_databases": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/logical-databases",
              "memberships": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/memberships",
              "name": "account-e01909ed-c9b5-48b1-9238-31bc93e9247d",
              "owners": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/owners",
              "plan": null,
              "providers": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/providers",
              "rds_management_web_uri": "https://example.org/accounts/219/database_services",
              "referrals": null,
              "referrer_account": null,
              "requests": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/requests",
              "server_alerts": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/server-alerts",
              "signup_via": "classic",
              "ssl_certificates": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/ssl-certificates",
              "support_plan": "standard",
              "support_trial": null,
              "support_trial_status": "NA",
              "updated_at": "2017-10-10T15:55:47+00:00",
              "users": "https://api.engineyard.com/accounts/e01909ed-c9b5-48b1-9238-31bc93e9247d/users"
            }
          }