Home
Version 3
Apps API

Apps API

List all Apps

GET /v2/apps

Request

Route

GET /v2/apps

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, diego, stack_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.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NSIsImVtYWlsIjoiZW1haWwtMjM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3MjR9.ALzcI5EQ6oKykW-PbvbgzJIiLR90cG0Vt8cKEDR9yWo
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NSIsImVtYWlsIjoiZW1haWwtMjM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3MjR9.ALzcI5EQ6oKykW-PbvbgzJIiLR90cG0Vt8cKEDR9yWo" \
	-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-03d9fb24-e4f5-409b-a098-d9cf05240eaf
stack_guid The guid of the associated stack.
  • guid-5d1e884a-dd77-4d19-baf2-48f751b38b8b
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
  • an_example_installed_buildpack
health_check_type Type of health check to perform. 'none' is deprecated and an alias to 'process'.
  • port
  • process
  • 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
  • true
  • false
enable_ssh Enable SSHing into the app. Supported for Diego only.
  • true
  • false
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_json Docker credentials for pulling docker image.
  • 200
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]
{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "1427b1dc-8531-4c8b-a46d-8a7cbca7eef6",
        "url": "/v2/apps/1427b1dc-8531-4c8b-a46d-8a7cbca7eef6",
        "created_at": "2016-05-12T00:45:24Z",
        "updated_at": "2016-05-12T00:45:24Z"
      },
      "entity": {
        "name": "name-2044",
        "production": false,
        "space_guid": "98587565-c115-469b-bde1-382a569cb7b6",
        "stack_guid": "1c2c21ce-7aab-4c50-abb1-917915a15d21",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "b40af0c0-3980-4bb7-b147-e10f3cf7dd0e",
        "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": "2016-05-12T00:45:24Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/98587565-c115-469b-bde1-382a569cb7b6",
        "stack_url": "/v2/stacks/1c2c21ce-7aab-4c50-abb1-917915a15d21",
        "routes_url": "/v2/apps/1427b1dc-8531-4c8b-a46d-8a7cbca7eef6/routes",
        "events_url": "/v2/apps/1427b1dc-8531-4c8b-a46d-8a7cbca7eef6/events",
        "service_bindings_url": "/v2/apps/1427b1dc-8531-4c8b-a46d-8a7cbca7eef6/service_bindings",
        "route_mappings_url": "/v2/apps/1427b1dc-8531-4c8b-a46d-8a7cbca7eef6/route_mappings"
      }
    },
    {
      "metadata": {
        "guid": "9ba2ef10-b735-4808-9b43-2ccdeacc5f5b",
        "url": "/v2/apps/9ba2ef10-b735-4808-9b43-2ccdeacc5f5b",
        "created_at": "2016-05-12T00:45:24Z",
        "updated_at": "2016-05-12T00:45:24Z"
      },
      "entity": {
        "name": "name-2038",
        "production": false,
        "space_guid": "dcc199a1-9e89-4a0d-b2b1-4b450ec7cc7d",
        "stack_guid": "8df51835-9415-49db-b491-2c7b5f7bcb8e",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "15258458-8a11-46c8-834a-139a9dc1070c",
        "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": "2016-05-12T00:45:24Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/dcc199a1-9e89-4a0d-b2b1-4b450ec7cc7d",
        "stack_url": "/v2/stacks/8df51835-9415-49db-b491-2c7b5f7bcb8e",
        "routes_url": "/v2/apps/9ba2ef10-b735-4808-9b43-2ccdeacc5f5b/routes",
        "events_url": "/v2/apps/9ba2ef10-b735-4808-9b43-2ccdeacc5f5b/events",
        "service_bindings_url": "/v2/apps/9ba2ef10-b735-4808-9b43-2ccdeacc5f5b/service_bindings",
        "route_mappings_url": "/v2/apps/9ba2ef10-b735-4808-9b43-2ccdeacc5f5b/route_mappings"
      }
    },
    {
      "metadata": {
        "guid": "a744fecb-43cc-4eba-85d8-d320ea7e9f6b",
        "url": "/v2/apps/a744fecb-43cc-4eba-85d8-d320ea7e9f6b",
        "created_at": "2016-05-12T00:45:24Z",
        "updated_at": "2016-05-12T00:45:24Z"
      },
      "entity": {
        "name": "name-2032",
        "production": false,
        "space_guid": "133b6131-ef78-4faa-b7d6-8243c8fc8475",
        "stack_guid": "e681bdca-2d8c-4507-9406-fdb591afda32",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "5df3717e-e5d5-4e29-abd1-09832ff30416",
        "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": "2016-05-12T00:45:24Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/133b6131-ef78-4faa-b7d6-8243c8fc8475",
        "stack_url": "/v2/stacks/e681bdca-2d8c-4507-9406-fdb591afda32",
        "routes_url": "/v2/apps/a744fecb-43cc-4eba-85d8-d320ea7e9f6b/routes",
        "events_url": "/v2/apps/a744fecb-43cc-4eba-85d8-d320ea7e9f6b/events",
        "service_bindings_url": "/v2/apps/a744fecb-43cc-4eba-85d8-d320ea7e9f6b/service_bindings",
        "route_mappings_url": "/v2/apps/a744fecb-43cc-4eba-85d8-d320ea7e9f6b/route_mappings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 63c2d6f1-3389-4c16-a228-26bd996f59bb
Content-Length: 5541
X-Content-Type-Options: nosniff