Beanstalk

Account Resource

Account owner privileges are required.

Readable attributes

id integer Unique ID of the Account.
owner_id integer ID of the User who owns the Account.
plan_id integer ID of the associated Plan.
name string Human-readable name. Usually company name.
third_level_domain string Sub-domain.
time_zone string Time zone that was selected during Sign Up.
public_key string Account-wide deployment key. Add this key to your server to make all ReleaseServers from your account to be able to deploy to it.
suspended boolean True if account was suspended due to failed monthly payment.
updated_at datetime Time when the integration was last updated.
created_at datetime Time when the account was first added to the system.

Writable attributes

name string Required on updated.
time_zone string Required on update

Find Account

json http-request 
GET /api/account.json

Click to expand…

json http-response 
{
  "account": {
    "name": "ilya",
    "created_at": "2011/07/20 23:11:17 +0800",
    "updated_at": "2011/10/03 13:16:06 +0800",
    "third_level_domain": "ilya",
    "owner_id": 2,
    "id": 2,
    "suspended": false,
    "time_zone": "International Date Line West",
    "plan_id": 24,
    "public_key": "ssh-rsa ..."
  }
}
xml http-request 
GET /api/account.xml

Click to expand…

xml http-response 
<?xml version="1.0" encoding="UTF-8"?>
<account>
  <id type="integer">3875</id>
  <owner-id type="integer">53533</owner-id>
  <plan-id type="integer">5</plan-id>
  <name>Super Account</name>
  <third-level-domain>super-account</third-level-domain>
  <time-zone>Krasnoyarsk</time-zone>
  <suspended type="boolean">false</suspended>
  <created-at type="datetime">2009-11-15T16:45:56Z</created-at>
  <updated-at type="datetime">2009-11-15T16:45:56Z</updated-at>
  <public-key>ssh-rsa ...</public-key>
</account>

Update Account

See the list of writable attributes at the top of the page. You only need to pass attributes that you want to change.

json http-request 
PUT /api/account.json
{
  "account": {
    "name": "Shikaka"
  }
}

Click to expand…

json http-response 
HEAD 200 OK
  
--OR IF INVALID--

{
  "errors": ["Error message"]
}
xml http-request 
PUT /api/account.xml
<?xml version="1.0" encoding="UTF-8"?>
<account>
  <name>New Company Name</name>
  <time-zone>International Date Line West</time-zone>
</account>

Click to expand…

xml http-response 
HEAD 200 OK
  
--OR IF INVALID--

<?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Name can't be blank</error>
</errors>