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-f3b51641-e623-43ad-bdfe-5d60b9e2c049
stack_guid The guid of the associated stack. Uses the default system stack.
  • guid-609905bd-4a61-450f-be11-6ff4919cf1c7
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:0x0000000616d090>
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
ports Ports on which application may listen. Supported for applications pushed to Diego only.
  • [5222, 8080]
  • [1056]

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTk4IiwiZW1haWwiOiJlbWFpbC02NUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ5NTMxNTEzfQ.ZEqqGVNQOmTobGcVIPBe7YoqyUVu_uGK_WJt3DY9ftg
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTk4IiwiZW1haWwiOiJlbWFpbC02NUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ5NTMxNTEzfQ.ZEqqGVNQOmTobGcVIPBe7YoqyUVu_uGK_WJt3DY9ftg" \
	-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": "6fa7a340-9bda-43bf-bd5e-4e588c292679",
        "url": "/v2/apps/6fa7a340-9bda-43bf-bd5e-4e588c292679",
        "created_at": "2015-11-30T23:38:33Z",
        "updated_at": "2015-11-30T23:38:33Z"
      },
      "entity": {
        "name": "name-423",
        "production": false,
        "space_guid": "5281e8e6-7cf4-4c0d-a316-97a910fbb13a",
        "stack_guid": "2d7a270e-3238-474c-b053-efe1920510bc",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "e2b0c9bd-1b6b-4bb5-b2cd-ae60fcf63d1b",
        "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-11-30T23:38:33Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/5281e8e6-7cf4-4c0d-a316-97a910fbb13a",
        "stack_url": "/v2/stacks/2d7a270e-3238-474c-b053-efe1920510bc",
        "events_url": "/v2/apps/6fa7a340-9bda-43bf-bd5e-4e588c292679/events",
        "service_bindings_url": "/v2/apps/6fa7a340-9bda-43bf-bd5e-4e588c292679/service_bindings",
        "routes_url": "/v2/apps/6fa7a340-9bda-43bf-bd5e-4e588c292679/routes"
      }
    },
    {
      "metadata": {
        "guid": "7002efa8-3f54-4338-8884-117e98f21566",
        "url": "/v2/apps/7002efa8-3f54-4338-8884-117e98f21566",
        "created_at": "2015-11-30T23:38:33Z",
        "updated_at": "2015-11-30T23:38:33Z"
      },
      "entity": {
        "name": "name-433",
        "production": false,
        "space_guid": "e03ab05c-abe3-4e0e-9704-c928d808c6c7",
        "stack_guid": "eddd425c-0e65-4814-a3e7-306fc628a733",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "06eb8c00-45cb-4264-af80-a6a51fc90ec3",
        "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-11-30T23:38:33Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/e03ab05c-abe3-4e0e-9704-c928d808c6c7",
        "stack_url": "/v2/stacks/eddd425c-0e65-4814-a3e7-306fc628a733",
        "events_url": "/v2/apps/7002efa8-3f54-4338-8884-117e98f21566/events",
        "service_bindings_url": "/v2/apps/7002efa8-3f54-4338-8884-117e98f21566/service_bindings",
        "routes_url": "/v2/apps/7002efa8-3f54-4338-8884-117e98f21566/routes"
      }
    },
    {
      "metadata": {
        "guid": "774a9f7e-895d-4825-84fc-222c1522a9a7",
        "url": "/v2/apps/774a9f7e-895d-4825-84fc-222c1522a9a7",
        "created_at": "2015-11-30T23:38:33Z",
        "updated_at": "2015-11-30T23:38:33Z"
      },
      "entity": {
        "name": "name-428",
        "production": false,
        "space_guid": "bafd65d5-d0bd-4044-8628-51249ea80238",
        "stack_guid": "a01229b7-f442-4bcb-a819-1aa84e62b6c5",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "94a152c2-028d-4378-8784-6b24f68ac492",
        "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-11-30T23:38:33Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/bafd65d5-d0bd-4044-8628-51249ea80238",
        "stack_url": "/v2/stacks/a01229b7-f442-4bcb-a819-1aa84e62b6c5",
        "events_url": "/v2/apps/774a9f7e-895d-4825-84fc-222c1522a9a7/events",
        "service_bindings_url": "/v2/apps/774a9f7e-895d-4825-84fc-222c1522a9a7/service_bindings",
        "routes_url": "/v2/apps/774a9f7e-895d-4825-84fc-222c1522a9a7/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 5256
X-Content-Type-Options: nosniff