Get Environment Data

Updated: January 14th, 2013

Get environment data

Allows you to get data about your environment. Most API operations require your environment ID.

Who can use it

Any user with an Engine Yard Cloud login and API token for the environment.

To get environment data


Valid response example

This example shows a new test environment with no instances yet. The "enviro_new_todo" environment ID is 44444:

"environments": [{
"id": 44444,
"name": "enviro_new_todo",
"ssh_username": "deploy",
"app_server_stack_name": "nginx_passenger3",
"framework_env": "production",
"instance_status": "none",
"instances_count": 0,
"load_balancer_ip_address": "50.112.999.999",
"account": {
"id": 11111,
"name": "my-1st-trial"
"stack_name": "nginx_passenger3",
"instances": [],
"app_master": null,
"apps": [{
"id": 22222,
"name": "app_myown_todo",
"repository_uri": "git://",
"app_type_id": "rails3",
"account": {
"id": 11111,
"name": "my-1st-trial"
"deployment_configurations": {
"app_myown_todo": {
"id": 55555,
"domain_name": "_",
"uri": null,
"migrate": {
"perform": true,
"command": "rake db:migrate"
"name": "app_myown_todo",
"repository_uri": "git://"

Curl example

This is an example of an environments operation using curl:

curl -v -H "X-EY-Cloud-Token: ENGINEYARD_API_TOKEN" -H "Accept: application/json" -H "Content-type: application/json"

Where ENGINEYARD_API_TOKEN looks something like this: 76f2d43d79bedd9bc74654a1ded733c9 See Get the API Token.

If you have feedback or questions about this page, add a comment below. If you need help, submit a ticket with Engine Yard Support.


Please sign in to leave a comment.

Powered by Zendesk