Home
Version 3
Apps API

Apps API

Retrieve a Particular App

GET /v2/apps/:guid

Fields

Name Description Default Valid Values Example Values
name The name of the app.
  • my_super_app
memory The amount of memory each instance should have. In megabytes.
  • 1024
  • 512
instances The number of instances of the app to run. To ensure optimal availability, ensure there are at least 2 instances.
  • 2
  • 6
  • 10
disk_quota The maximum amount of disk available to an instance of an app. In megabytes.
  • 1204
  • 2048
space_guid The guid of the associated space.
  • guid-960f983c-5db0-4def-a102-26a4657c8b6f
stack_guid The guid of the associated stack. Uses the default system stack.
state The current desired state of the app. One of STOPPED or STARTED. STOPPED
  • STOPPED
  • STARTED
detected_start_command The command detected by the buildpack during staging.
command The command to start an app after it is staged (e.g. 'rails s -p $PORT' or 'java com.org.Server $PORT').
buildpack Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
  • https://github.com/virtualstaticvoid/heroku-buildpack-r.git
  • an_example_installed_buildpack
health_check_type Type of health check to perform. port
  • port
  • none
health_check_timeout Timeout for health checking of an staged app when starting up
docker_image Name of the Docker image containing the app
  • cloudfoundry/helloworld
  • registry.example.com:5000/user/repository/tag
environment_json Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
production Deprecated. true
  • true
  • false
console Open the console port for the app (at $CONSOLE_PORT). false
  • true
  • false
debug Open the debug port for the app (at $DEBUG_PORT). false
  • true
  • false

Parameters

Name Description Valid Values Example Values
guid The guid of the App

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MyIsImVtYWlsIjoiZW1haWwtOTVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxOTk4OTk2OH0.TyQRs7LfcZaZc5Z4vIzwDqan7Nd4GjqvCEAAYMW8nc8
Host: example.org
Cookie: 

Route

GET /v2/apps/be787b71-13ce-4e93-a407-fd491e329505

cURL

curl "https://api.[your-domain.com]/v2/apps/be787b71-13ce-4e93-a407-fd491e329505" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MyIsImVtYWlsIjoiZW1haWwtOTVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxOTk4OTk2OH0.TyQRs7LfcZaZc5Z4vIzwDqan7Nd4GjqvCEAAYMW8nc8" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 80d4c0b9-328f-45e4-a02f-84a0af1e3497
Content-Length: 1358
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "be787b71-13ce-4e93-a407-fd491e329505",
    "url": "/v2/apps/be787b71-13ce-4e93-a407-fd491e329505",
    "created_at": "2014-12-24T01:39:28+00:00",
    "updated_at": "2014-12-24T01:39:28+00:00"
  },
  "entity": {
    "name": "name-1129",
    "production": false,
    "space_guid": "72ef475c-dc6b-4002-b611-16a0d721602b",
    "stack_guid": "7bab67ba-0b12-41ef-a5c7-2531baedcfc3",
    "buildpack": null,
    "detected_buildpack": null,
    "environment_json": null,
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STOPPED",
    "version": "be77e086-c602-40cb-a26b-6eca6d41a9b0",
    "command": null,
    "console": false,
    "debug": null,
    "staging_task_id": null,
    "package_state": "PENDING",
    "health_check_type": "port",
    "health_check_timeout": null,
    "staging_failed_reason": null,
    "docker_image": null,
    "package_updated_at": "2014-12-24T01:39:28+00:00",
    "detected_start_command": "",
    "space_url": "/v2/spaces/72ef475c-dc6b-4002-b611-16a0d721602b",
    "stack_url": "/v2/stacks/7bab67ba-0b12-41ef-a5c7-2531baedcfc3",
    "events_url": "/v2/apps/be787b71-13ce-4e93-a407-fd491e329505/events",
    "service_bindings_url": "/v2/apps/be787b71-13ce-4e93-a407-fd491e329505/service_bindings",
    "routes_url": "/v2/apps/be787b71-13ce-4e93-a407-fd491e329505/routes"
  }
}