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
billing_plan_support
required: false
Billing plan support of accounts
legacy_id
required: false
Support plan of accounts

Request

          Accept: application/json
          Content-Type: application/json
          
            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "accounts": [
              {
                "id": "d995b99b-5c9d-40fe-b363-31b2bfe1a2da",
                "account_notes": "https://api.engineyard.com/accounts-notes.d995b99b-5c9d-40fe-b363-31b2bfe1a2da",
                "account_trial": null,
                "addons": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/addons",
                "addresses": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/addresses",
                "applications": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/applications",
                "billable": true,
                "billing_plan_support": "standard",
                "billing_required": false,
                "billing_signup_url": null,
                "canceled_at": null,
                "cancellation": null,
                "cancelled_at": null,
                "created_at": "2018-04-12T18:07:23+00:00",
                "database_services": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/database-services",
                "emergency_contact": null,
                "environments": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/environments",
                "features": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/features",
                "finalized": true,
                "logical_databases": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/logical-databases",
                "memberships": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/memberships",
                "name": "account-d995b99b-5c9d-40fe-b363-31b2bfe1a2da",
                "owners": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/owners",
                "plan": null,
                "providers": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/providers",
                "rds_management_web_uri": "https://example.org/accounts/152/database_services",
                "referrals": null,
                "referrer_account": null,
                "requests": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/requests",
                "server_alerts": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/server-alerts",
                "signup_via": "classic",
                "ssl_certificates": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/ssl-certificates",
                "support_plan": "standard",
                "support_trial": null,
                "support_trial_status": "NA",
                "updated_at": "2018-04-12T18:07:23+00:00",
                "users": "https://api.engineyard.com/accounts/d995b99b-5c9d-40fe-b363-31b2bfe1a2da/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
billing_plan_support
required: false
Billing plan support of accounts
legacy_id
required: false
Support plan of accounts

Request

          Accept: application/json
          Content-Type: application/json
          
            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "accounts": [
              {
                "id": "d54797d3-dfeb-4745-9ef5-a0d846ef1bbc",
                "account_notes": "https://api.engineyard.com/accounts-notes.d54797d3-dfeb-4745-9ef5-a0d846ef1bbc",
                "account_trial": null,
                "addons": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/addons",
                "addresses": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/addresses",
                "applications": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/applications",
                "billable": true,
                "billing_plan_support": "standard",
                "billing_required": false,
                "billing_signup_url": null,
                "canceled_at": null,
                "cancellation": null,
                "cancelled_at": null,
                "created_at": "2018-04-12T18:07:26+00:00",
                "database_services": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/database-services",
                "emergency_contact": null,
                "environments": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/environments",
                "features": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/features",
                "finalized": true,
                "logical_databases": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/logical-databases",
                "memberships": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/memberships",
                "name": "account-d54797d3-dfeb-4745-9ef5-a0d846ef1bbc",
                "owners": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/owners",
                "plan": null,
                "providers": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/providers",
                "rds_management_web_uri": "https://example.org/accounts/153/database_services",
                "referrals": null,
                "referrer_account": null,
                "requests": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/requests",
                "server_alerts": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/server-alerts",
                "signup_via": "classic",
                "ssl_certificates": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/ssl-certificates",
                "support_plan": "standard",
                "support_trial": null,
                "support_trial_status": "NA",
                "updated_at": "2018-04-12T18:07:26+00:00",
                "users": "https://api.engineyard.com/accounts/d54797d3-dfeb-4745-9ef5-a0d846ef1bbc/users"
              }
            ]
          }
            
          








Show an account

GET /accounts/:account_id

Request

          Accept: application/json
          Content-Type: application/json
          
            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "account": {
              "id": "f9e4f999-80ed-49dc-a3f9-9e564259029c",
              "account_notes": "https://api.engineyard.com/accounts-notes.f9e4f999-80ed-49dc-a3f9-9e564259029c",
              "account_trial": null,
              "addons": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/addons",
              "addresses": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/addresses",
              "applications": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/applications",
              "billable": true,
              "billing_plan_support": "standard",
              "billing_required": false,
              "billing_signup_url": null,
              "canceled_at": null,
              "cancellation": null,
              "cancelled_at": null,
              "created_at": "2018-04-12T18:07:28+00:00",
              "database_services": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/database-services",
              "emergency_contact": null,
              "environments": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/environments",
              "features": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/features",
              "finalized": true,
              "logical_databases": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/logical-databases",
              "memberships": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/memberships",
              "name": "account-f9e4f999-80ed-49dc-a3f9-9e564259029c",
              "owners": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/owners",
              "plan": null,
              "providers": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/providers",
              "rds_management_web_uri": "https://example.org/accounts/154/database_services",
              "referrals": null,
              "referrer_account": null,
              "requests": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/requests",
              "server_alerts": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/server-alerts",
              "signup_via": "classic",
              "ssl_certificates": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/ssl-certificates",
              "support_plan": "standard",
              "support_trial": null,
              "support_trial_status": "NA",
              "updated_at": "2018-04-12T18:07:28+00:00",
              "users": "https://api.engineyard.com/accounts/f9e4f999-80ed-49dc-a3f9-9e564259029c/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": "50e35e6b-1410-400b-9311-2c456118b07d",
              "account_notes": "https://api.engineyard.com/accounts-notes.50e35e6b-1410-400b-9311-2c456118b07d",
              "account_trial": null,
              "addons": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/addons",
              "addresses": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/addresses",
              "applications": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/applications",
              "billable": true,
              "billing_plan_support": "standard",
              "billing_required": false,
              "billing_signup_url": null,
              "canceled_at": null,
              "cancellation": null,
              "cancelled_at": null,
              "created_at": "2018-04-12T18:07:31+00:00",
              "database_services": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/database-services",
              "emergency_contact": "My New Emergency Contact",
              "environments": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/environments",
              "features": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/features",
              "finalized": true,
              "logical_databases": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/logical-databases",
              "memberships": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/memberships",
              "name": "account-50e35e6b-1410-400b-9311-2c456118b07d",
              "owners": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/owners",
              "plan": null,
              "providers": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/providers",
              "rds_management_web_uri": "https://example.org/accounts/155/database_services",
              "referrals": null,
              "referrer_account": null,
              "requests": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/requests",
              "server_alerts": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/server-alerts",
              "signup_via": "classic",
              "ssl_certificates": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/ssl-certificates",
              "support_plan": "standard",
              "support_trial": null,
              "support_trial_status": "NA",
              "updated_at": "2018-04-12T18:07:33+00:00",
              "users": "https://api.engineyard.com/accounts/50e35e6b-1410-400b-9311-2c456118b07d/users"
            }
          }