Home
Version 3
Apps API

Apps API

Retrieve a Particular App

GET /v2/apps/:guid

Request

Route

GET /v2/apps/03f286bb-f17c-42b4-8dcd-b818b0b798af

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-bf68c0d3-16ca-423f-886e-5e88f89b5c9f
stack_guid The guid of the associated stack. Uses the default system stack.
  • guid-307885fb-d952-4c48-8f04-663dd6e2a95c
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:0x00000007fc1cf8>
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.eyJ1c2VyX2lkIjoidWFhLWlkLTIzOSIsImVtYWlsIjoiZW1haWwtMTY0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE4MDB9.VmHJkeAUWpt-Ie6qqeavuClBKk8GEatmnTqHdtJsswE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/03f286bb-f17c-42b4-8dcd-b818b0b798af" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzOSIsImVtYWlsIjoiZW1haWwtMTY0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE4MDB9.VmHJkeAUWpt-Ie6qqeavuClBKk8GEatmnTqHdtJsswE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "03f286bb-f17c-42b4-8dcd-b818b0b798af",
    "url": "/v2/apps/03f286bb-f17c-42b4-8dcd-b818b0b798af",
    "created_at": "2015-07-27T22:43:20Z",
    "updated_at": "2015-07-27T22:43:20Z"
  },
  "entity": {
    "name": "name-751",
    "production": false,
    "space_guid": "b10ca4ed-fa71-4597-8567-e7dd1719c0c7",
    "stack_guid": "160fb300-c60e-4682-8527-8500e0318839",
    "buildpack": null,
    "detected_buildpack": null,
    "environment_json": null,
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STOPPED",
    "version": "2b0d7e20-ce57-44b4-b0ec-7ca6d1d50e20",
    "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-07-27T22:43:20Z",
    "detected_start_command": "",
    "enable_ssh": true,
    "docker_credentials_json": {
      "redacted_message": "[PRIVATE DATA HIDDEN]"
    },
    "space_url": "/v2/spaces/b10ca4ed-fa71-4597-8567-e7dd1719c0c7",
    "stack_url": "/v2/stacks/160fb300-c60e-4682-8527-8500e0318839",
    "events_url": "/v2/apps/03f286bb-f17c-42b4-8dcd-b818b0b798af/events",
    "service_bindings_url": "/v2/apps/03f286bb-f17c-42b4-8dcd-b818b0b798af/service_bindings",
    "routes_url": "/v2/apps/03f286bb-f17c-42b4-8dcd-b818b0b798af/routes"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 3e07a772-755b-4e00-a055-d0f5550b553e
Content-Length: 1516
X-Content-Type-Options: nosniff