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

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:0x0000000a77f7b8>
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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMSIsImVtYWlsIjoiZW1haWwtODlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NDc4MjkyOX0.1OFYyKqCMX-9JdJ3WUag21iy23Aqup3Vxuf6anRmFQU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMSIsImVtYWlsIjoiZW1haWwtODlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NDc4MjkyOX0.1OFYyKqCMX-9JdJ3WUag21iy23Aqup3Vxuf6anRmFQU" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "8c943e87-c00c-4d0b-8583-d5c49111a5ec",
        "url": "/v2/apps/8c943e87-c00c-4d0b-8583-d5c49111a5ec",
        "created_at": "2015-10-07T00:35:29Z",
        "updated_at": "2015-10-07T00:35:29Z"
      },
      "entity": {
        "name": "name-616",
        "production": false,
        "space_guid": "801d80bc-0314-48c0-bd7a-20cbb230c922",
        "stack_guid": "be84c0e2-afc6-4c65-95aa-24e1abe00b7e",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "26d127ce-4e4f-4f90-84e5-ac3b1e6ce484",
        "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/801d80bc-0314-48c0-bd7a-20cbb230c922",
        "stack_url": "/v2/stacks/be84c0e2-afc6-4c65-95aa-24e1abe00b7e",
        "events_url": "/v2/apps/8c943e87-c00c-4d0b-8583-d5c49111a5ec/events",
        "service_bindings_url": "/v2/apps/8c943e87-c00c-4d0b-8583-d5c49111a5ec/service_bindings",
        "routes_url": "/v2/apps/8c943e87-c00c-4d0b-8583-d5c49111a5ec/routes"
      }
    },
    {
      "metadata": {
        "guid": "8f4ac7dd-5065-4ff4-a686-f743bba795fe",
        "url": "/v2/apps/8f4ac7dd-5065-4ff4-a686-f743bba795fe",
        "created_at": "2015-10-07T00:35:29Z",
        "updated_at": "2015-10-07T00:35:29Z"
      },
      "entity": {
        "name": "name-611",
        "production": false,
        "space_guid": "151c8675-477a-4da5-a629-f120d9381a76",
        "stack_guid": "fa0e38a1-34c4-4bff-a6ea-2849edbe0bf8",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "ca383548-f30b-44c6-9fbe-a63a4f59b3a9",
        "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/151c8675-477a-4da5-a629-f120d9381a76",
        "stack_url": "/v2/stacks/fa0e38a1-34c4-4bff-a6ea-2849edbe0bf8",
        "events_url": "/v2/apps/8f4ac7dd-5065-4ff4-a686-f743bba795fe/events",
        "service_bindings_url": "/v2/apps/8f4ac7dd-5065-4ff4-a686-f743bba795fe/service_bindings",
        "routes_url": "/v2/apps/8f4ac7dd-5065-4ff4-a686-f743bba795fe/routes"
      }
    },
    {
      "metadata": {
        "guid": "af72424a-0bfa-46f4-8bc1-4f120f50c904",
        "url": "/v2/apps/af72424a-0bfa-46f4-8bc1-4f120f50c904",
        "created_at": "2015-10-07T00:35:29Z",
        "updated_at": "2015-10-07T00:35:29Z"
      },
      "entity": {
        "name": "name-606",
        "production": false,
        "space_guid": "85472bb3-9cfe-4903-bd09-328fd83170d9",
        "stack_guid": "50cefed1-737b-4cad-9061-b5bb63042e01",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "a880f5b9-a96d-4a2c-a603-cfe67df6d7ef",
        "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/85472bb3-9cfe-4903-bd09-328fd83170d9",
        "stack_url": "/v2/stacks/50cefed1-737b-4cad-9061-b5bb63042e01",
        "events_url": "/v2/apps/af72424a-0bfa-46f4-8bc1-4f120f50c904/events",
        "service_bindings_url": "/v2/apps/af72424a-0bfa-46f4-8bc1-4f120f50c904/service_bindings",
        "routes_url": "/v2/apps/af72424a-0bfa-46f4-8bc1-4f120f50c904/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a157f833-67e2-413a-aa45-7586af80057f
Content-Length: 5187
X-Content-Type-Options: nosniff