Home
Version 3
Apps API

Apps API

List all Apps

GET /v2/apps

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-e469b677-c4ee-47d2-9762-d6bb8c48af28
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_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
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name, space_guid, organization_guid
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2NyIsImVtYWlsIjoiZW1haWwtMTkyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDR9.n5JxZwlBA8PPBqgZWynV72d5OzQH5hyRcY5lMjaPLJ4
Host: example.org
Cookie: 

Route

GET /v2/apps

cURL

curl "https://api.[your-domain.com]/v2/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2NyIsImVtYWlsIjoiZW1haWwtMTkyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDR9.n5JxZwlBA8PPBqgZWynV72d5OzQH5hyRcY5lMjaPLJ4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 3217b8b6-ae16-4d17-baed-8110f703b12c
Content-Length: 4527
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "81b11a7f-ae46-4ca7-9272-ca67b80f0848",
        "url": "/v2/apps/81b11a7f-ae46-4ca7-9272-ca67b80f0848",
        "created_at": "2014-11-05T01:02:24+00:00",
        "updated_at": "2014-11-05T01:02:24+00:00"
      },
      "entity": {
        "name": "name-909",
        "production": false,
        "space_guid": "d8053637-e3bf-4105-bdd5-1d4d87c666d1",
        "stack_guid": "baed44cd-c3c5-4175-b4d2-4c689032baaa",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "70440e50-bbf5-46bf-b9b8-5a5f5527c5f0",
        "command": null,
        "console": false,
        "debug": null,
        "staging_task_id": null,
        "package_state": "PENDING",
        "health_check_timeout": null,
        "staging_failed_reason": null,
        "docker_image": null,
        "package_updated_at": "2014-11-05T01:02:24+00:00",
        "detected_start_command": "",
        "space_url": "/v2/spaces/d8053637-e3bf-4105-bdd5-1d4d87c666d1",
        "stack_url": "/v2/stacks/baed44cd-c3c5-4175-b4d2-4c689032baaa",
        "events_url": "/v2/apps/81b11a7f-ae46-4ca7-9272-ca67b80f0848/events",
        "service_bindings_url": "/v2/apps/81b11a7f-ae46-4ca7-9272-ca67b80f0848/service_bindings",
        "routes_url": "/v2/apps/81b11a7f-ae46-4ca7-9272-ca67b80f0848/routes"
      }
    },
    {
      "metadata": {
        "guid": "a4a1f2ac-da76-487a-9e5f-9d92c11b7400",
        "url": "/v2/apps/a4a1f2ac-da76-487a-9e5f-9d92c11b7400",
        "created_at": "2014-11-05T01:02:24+00:00",
        "updated_at": "2014-11-05T01:02:24+00:00"
      },
      "entity": {
        "name": "name-899",
        "production": false,
        "space_guid": "324729b8-4a68-467d-b013-ae709787a8f7",
        "stack_guid": "ac3207de-221c-4546-9986-fac451be115e",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "9b0caf2c-66e3-4a6d-bdcf-cfe53d4bd926",
        "command": null,
        "console": false,
        "debug": null,
        "staging_task_id": null,
        "package_state": "PENDING",
        "health_check_timeout": null,
        "staging_failed_reason": null,
        "docker_image": null,
        "package_updated_at": "2014-11-05T01:02:24+00:00",
        "detected_start_command": "",
        "space_url": "/v2/spaces/324729b8-4a68-467d-b013-ae709787a8f7",
        "stack_url": "/v2/stacks/ac3207de-221c-4546-9986-fac451be115e",
        "events_url": "/v2/apps/a4a1f2ac-da76-487a-9e5f-9d92c11b7400/events",
        "service_bindings_url": "/v2/apps/a4a1f2ac-da76-487a-9e5f-9d92c11b7400/service_bindings",
        "routes_url": "/v2/apps/a4a1f2ac-da76-487a-9e5f-9d92c11b7400/routes"
      }
    },
    {
      "metadata": {
        "guid": "ebe6a4a4-8768-41f5-ad72-33f44757b60c",
        "url": "/v2/apps/ebe6a4a4-8768-41f5-ad72-33f44757b60c",
        "created_at": "2014-11-05T01:02:24+00:00",
        "updated_at": "2014-11-05T01:02:24+00:00"
      },
      "entity": {
        "name": "name-904",
        "production": false,
        "space_guid": "dae05815-8cc9-4210-825f-0a925273458a",
        "stack_guid": "baaa155f-e3b6-48b8-a5e1-5dba66688fcd",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "a1d84464-0f67-42b7-9430-618598986bfc",
        "command": null,
        "console": false,
        "debug": null,
        "staging_task_id": null,
        "package_state": "PENDING",
        "health_check_timeout": null,
        "staging_failed_reason": null,
        "docker_image": null,
        "package_updated_at": "2014-11-05T01:02:24+00:00",
        "detected_start_command": "",
        "space_url": "/v2/spaces/dae05815-8cc9-4210-825f-0a925273458a",
        "stack_url": "/v2/stacks/baaa155f-e3b6-48b8-a5e1-5dba66688fcd",
        "events_url": "/v2/apps/ebe6a4a4-8768-41f5-ad72-33f44757b60c/events",
        "service_bindings_url": "/v2/apps/ebe6a4a4-8768-41f5-ad72-33f44757b60c/service_bindings",
        "routes_url": "/v2/apps/ebe6a4a4-8768-41f5-ad72-33f44757b60c/routes"
      }
    }
  ]
}