Home
Version 3
Apps API

Apps API

Retrieve a Particular App

GET /v2/apps/:guid

Request

Route

GET /v2/apps/0470b450-195a-4550-a012-1e27812f54c0

Body

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-4b24cf94-9a7b-41d3-9bff-5c08e54709e4
stack_guid The guid of the associated stack. Uses the default system stack.
  • guid-c812ec16-eb81-43d4-ab69-64d346b37815
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, maximum length: 4096 (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
diego Use diego to stage and to run when available false
  • true
  • false
docker_image Name of the Docker image containing the app
  • cloudfoundry/helloworld
  • registry.example.com:5000/user/repository/tag
docker_credentials_json Docker credentials for pulling docker image. {}
  • #<RspecApiDocumentation::Views::HtmlExample:0x000000065b4f90>
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
staging_failed_reason Reason for application staging failures
staging_failed_description Detailed description for the staging_failed_reason

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMCIsImVtYWlsIjoiZW1haWwtODhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NDc4MjkyOX0.UA3sGmxVB4JWEvxUHhefATyEbvhzJRvxVAnoAiTgvBI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/0470b450-195a-4550-a012-1e27812f54c0" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMCIsImVtYWlsIjoiZW1haWwtODhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NDc4MjkyOX0.UA3sGmxVB4JWEvxUHhefATyEbvhzJRvxVAnoAiTgvBI" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "0470b450-195a-4550-a012-1e27812f54c0",
    "url": "/v2/apps/0470b450-195a-4550-a012-1e27812f54c0",
    "created_at": "2015-10-07T00:35:29Z",
    "updated_at": "2015-10-07T00:35:29Z"
  },
  "entity": {
    "name": "name-601",
    "production": false,
    "space_guid": "09dbaddc-fb6d-4ec1-80be-0d5bedc5a061",
    "stack_guid": "a7b2e607-10a0-49c3-8b62-1beee7db5a58",
    "buildpack": null,
    "detected_buildpack": null,
    "environment_json": null,
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STOPPED",
    "version": "5efee5cb-1218-4607-9b55-24b25a3662d3",
    "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,
    "staging_failed_description": null,
    "diego": false,
    "docker_image": null,
    "package_updated_at": "2015-10-07T00:35:29Z",
    "detected_start_command": "",
    "enable_ssh": true,
    "docker_credentials_json": {
      "redacted_message": "[PRIVATE DATA HIDDEN]"
    },
    "space_url": "/v2/spaces/09dbaddc-fb6d-4ec1-80be-0d5bedc5a061",
    "stack_url": "/v2/stacks/a7b2e607-10a0-49c3-8b62-1beee7db5a58",
    "events_url": "/v2/apps/0470b450-195a-4550-a012-1e27812f54c0/events",
    "service_bindings_url": "/v2/apps/0470b450-195a-4550-a012-1e27812f54c0/service_bindings",
    "routes_url": "/v2/apps/0470b450-195a-4550-a012-1e27812f54c0/routes"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ed8598ae-13c0-4eea-b1ec-d4a1c2629ced
Content-Length: 1516
X-Content-Type-Options: nosniff