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-66f00402-f886-4a38-b1a8-ad1a3797207e
stack_guid The guid of the associated stack. Uses the default system stack.
  • guid-88feb2b8-fc74-4a82-9b24-f9930e80f1f8
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:0x00000008a06d58>
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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMSIsImVtYWlsIjoiZW1haWwtMjM4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTd9.WfJGukqdHGen0ZphQnlKWRfJOiyQL9Yvy9PO2fC7i9M
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMSIsImVtYWlsIjoiZW1haWwtMjM4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTd9.WfJGukqdHGen0ZphQnlKWRfJOiyQL9Yvy9PO2fC7i9M" \
	-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": "672a52dc-cd86-4690-9deb-7b8a4c1853e1",
        "url": "/v2/apps/672a52dc-cd86-4690-9deb-7b8a4c1853e1",
        "created_at": "2015-06-04T00:05:17Z",
        "updated_at": "2015-06-04T00:05:17Z"
      },
      "entity": {
        "name": "name-1919",
        "production": false,
        "space_guid": "f75a0e06-6aea-4355-a924-1179a44bf15e",
        "stack_guid": "3cfaa1a8-5232-4b25-909f-5de5d48d445f",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "0c05f704-9e4c-4ac2-a457-f36ec1f37f9e",
        "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,
        "diego": false,
        "docker_image": null,
        "package_updated_at": "2015-06-04T00:05:17Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "space_url": "/v2/spaces/f75a0e06-6aea-4355-a924-1179a44bf15e",
        "stack_url": "/v2/stacks/3cfaa1a8-5232-4b25-909f-5de5d48d445f",
        "events_url": "/v2/apps/672a52dc-cd86-4690-9deb-7b8a4c1853e1/events",
        "service_bindings_url": "/v2/apps/672a52dc-cd86-4690-9deb-7b8a4c1853e1/service_bindings",
        "routes_url": "/v2/apps/672a52dc-cd86-4690-9deb-7b8a4c1853e1/routes"
      }
    },
    {
      "metadata": {
        "guid": "78a24822-83d1-4c9b-a0d4-09921159a48e",
        "url": "/v2/apps/78a24822-83d1-4c9b-a0d4-09921159a48e",
        "created_at": "2015-06-04T00:05:17Z",
        "updated_at": "2015-06-04T00:05:17Z"
      },
      "entity": {
        "name": "name-1909",
        "production": false,
        "space_guid": "8f9f3012-a0f0-4406-8ea6-9e7613662cf1",
        "stack_guid": "4a64b15b-56a0-447e-93f8-fc70b8d36d8a",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "1d815415-12c3-4215-b3a4-19601fb7b03e",
        "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,
        "diego": false,
        "docker_image": null,
        "package_updated_at": "2015-06-04T00:05:17Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "space_url": "/v2/spaces/8f9f3012-a0f0-4406-8ea6-9e7613662cf1",
        "stack_url": "/v2/stacks/4a64b15b-56a0-447e-93f8-fc70b8d36d8a",
        "events_url": "/v2/apps/78a24822-83d1-4c9b-a0d4-09921159a48e/events",
        "service_bindings_url": "/v2/apps/78a24822-83d1-4c9b-a0d4-09921159a48e/service_bindings",
        "routes_url": "/v2/apps/78a24822-83d1-4c9b-a0d4-09921159a48e/routes"
      }
    },
    {
      "metadata": {
        "guid": "ffd27513-0634-4ede-9ad8-07aea8fa4ba9",
        "url": "/v2/apps/ffd27513-0634-4ede-9ad8-07aea8fa4ba9",
        "created_at": "2015-06-04T00:05:17Z",
        "updated_at": "2015-06-04T00:05:17Z"
      },
      "entity": {
        "name": "name-1914",
        "production": false,
        "space_guid": "35900ae3-48f1-4a14-83cb-24a08af101e1",
        "stack_guid": "2b9a57d0-1a26-46f6-88e7-b52c433fa271",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "6f76ab08-c3e5-4645-a535-7ffe37ae4f3b",
        "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,
        "diego": false,
        "docker_image": null,
        "package_updated_at": "2015-06-04T00:05:17Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "space_url": "/v2/spaces/35900ae3-48f1-4a14-83cb-24a08af101e1",
        "stack_url": "/v2/stacks/2b9a57d0-1a26-46f6-88e7-b52c433fa271",
        "events_url": "/v2/apps/ffd27513-0634-4ede-9ad8-07aea8fa4ba9/events",
        "service_bindings_url": "/v2/apps/ffd27513-0634-4ede-9ad8-07aea8fa4ba9/service_bindings",
        "routes_url": "/v2/apps/ffd27513-0634-4ede-9ad8-07aea8fa4ba9/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 5c2fd77b-2364-438a-8eb7-31be5d0da116
Content-Length: 5058
X-Content-Type-Options: nosniff