Apps API

Retrieve a Particular App

GET /v2/apps/:guid

Request

Route

GET /v2/apps/15b3885d-0351-4b9b-8697-86641668c123

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MSIsImVtYWlsIjoiZW1haWwtMzAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDV9.Bs5aQIQEBp41syeW-4pJcDrkjQ6jihPHO587zev8N8g
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/apps/15b3885d-0351-4b9b-8697-86641668c123" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MSIsImVtYWlsIjoiZW1haWwtMzAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDV9.Bs5aQIQEBp41syeW-4pJcDrkjQ6jihPHO587zev8N8g" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

Name Description 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-3f271b25-af61-402a-a032-679d6838042d
stack_guid The guid of the associated stack.
  • guid-169d5fac-8aa6-428d-8715-dead26221593
state The current desired state of the app. One of STOPPED or STARTED.
  • STOPPED
  • STARTED
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
  • ruby 1.6.20
detected_buildpack Buildpack that has been found for the app through autodetection
  • ruby 1.6.20
detected_buildpack_guid Guid of the detected_buildpack
  • d12fdf1a-f061-4040-81f4-b5b5b55570bd
health_check_http_endpoint Endpoint called to determine if the app is healthy.
  • /health
health_check_type Type of health check to perform. 'none' is deprecated and an alias to 'process'.
  • http
  • port
  • process
  • none
health_check_timeout Timeout in seconds for health checking of an staged app when starting up
diego Use diego to stage and to run when available
  • true
  • false
enable_ssh Enable SSHing into the app. Supported for Diego only.
  • true
  • false
detected_start_command The command detected by the buildpack during staging.
  • rails s
docker_image Name of the Docker image containing the app. The "diego_docker" feature flag must be enabled in order to create Docker image apps.
  • cloudfoundry/diego-docker-app
  • registry.example.com:5000/user/repository/tag
docker_credentials Docker credentials for pulling docker image.
  • {"username": "user", "password": "***"}
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
  • false
console Open the console port for the app (at $CONSOLE_PORT).
  • true
  • false
debug Open the debug port for the app (at $DEBUG_PORT).
  • true
  • false
staging_failed_reason Reason for application staging failures
  • StagingError
  • StagingTimeExpired
staging_failed_description Detailed description for the staging_failed_reason
  • An app was not successfully detected by any available buildpack
ports Ports on which application may listen. Overwrites previously configured ports. Ports must be in range 1024-65535. Supported for Diego only.
  • [5222, 8080]
  • [1056]
 
{
  "metadata": {
    "guid": "15b3885d-0351-4b9b-8697-86641668c123",
    "url": "/v2/apps/15b3885d-0351-4b9b-8697-86641668c123",
    "created_at": "2016-06-08T16:41:44Z",
    "updated_at": "2016-06-08T16:41:44Z"
  },
  "entity": {
    "name": "name-2401",
    "production": false,
    "space_guid": "7846301e-c84c-4ba9-9c6a-2dfdae948d52",
    "stack_guid": "7e03186d-a438-4285-b3b7-c426532e1df2",
    "buildpack": null,
    "detected_buildpack": null,
    "detected_buildpack_guid": null,
    "environment_json": null,
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STOPPED",
    "version": "df19a7ea-2003-4ecb-a909-e630e43f2719",
    "command": null,
    "console": false,
    "debug": null,
    "staging_task_id": null,
    "package_state": "PENDING",
    "health_check_http_endpoint": "",
    "health_check_type": "port",
    "health_check_timeout": null,
    "staging_failed_reason": null,
    "staging_failed_description": null,
    "diego": false,
    "docker_image": null,
    "docker_credentials": {
      "username": null,
      "password": null
    },
    "package_updated_at": "2016-06-08T16:41:45Z",
    "detected_start_command": "",
    "enable_ssh": true,
    "ports": null,
    "space_url": "/v2/spaces/7846301e-c84c-4ba9-9c6a-2dfdae948d52",
    "stack_url": "/v2/stacks/7e03186d-a438-4285-b3b7-c426532e1df2",
    "routes_url": "/v2/apps/15b3885d-0351-4b9b-8697-86641668c123/routes",
    "events_url": "/v2/apps/15b3885d-0351-4b9b-8697-86641668c123/events",
    "service_bindings_url": "/v2/apps/15b3885d-0351-4b9b-8697-86641668c123/service_bindings",
    "route_mappings_url": "/v2/apps/15b3885d-0351-4b9b-8697-86641668c123/route_mappings"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: fb8f622e-abfd-4aba-9da9-89ae37ea54a3
Content-Length: 1626
X-Content-Type-Options: nosniff