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-5b2d71f2-e68b-4e62-92ab-e9d79f9410a6
stack_guid The guid of the associated stack. Uses the default system stack.
  • guid-91ec9be0-c1dc-4054-97a4-e5f0f16c07e3
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:0x000000062a0368>
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.eyJ1c2VyX2lkIjoidWFhLWlkLTM5NiIsImVtYWlsIjoiZW1haWwtMjY0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NTZ9.1MLGXmLgzGKatjVaO48RmY64d_e217GCl6Gw_oLzars
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5NiIsImVtYWlsIjoiZW1haWwtMjY0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NTZ9.1MLGXmLgzGKatjVaO48RmY64d_e217GCl6Gw_oLzars" \
	-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": "4a8037a6-19b9-4cbc-95f5-e63b280e7acc",
        "url": "/v2/apps/4a8037a6-19b9-4cbc-95f5-e63b280e7acc",
        "created_at": "2015-09-30T23:30:56Z",
        "updated_at": "2015-09-30T23:30:56Z"
      },
      "entity": {
        "name": "name-2018",
        "production": false,
        "space_guid": "c6d82d6e-21b3-412c-b368-3910ebaeff95",
        "stack_guid": "f103010f-ee31-4fe5-9bd9-99524ccd9b98",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "eb133546-f0af-4e3b-943e-4984ad7f6647",
        "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-09-30T23:30:56Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "space_url": "/v2/spaces/c6d82d6e-21b3-412c-b368-3910ebaeff95",
        "stack_url": "/v2/stacks/f103010f-ee31-4fe5-9bd9-99524ccd9b98",
        "events_url": "/v2/apps/4a8037a6-19b9-4cbc-95f5-e63b280e7acc/events",
        "service_bindings_url": "/v2/apps/4a8037a6-19b9-4cbc-95f5-e63b280e7acc/service_bindings",
        "routes_url": "/v2/apps/4a8037a6-19b9-4cbc-95f5-e63b280e7acc/routes"
      }
    },
    {
      "metadata": {
        "guid": "a7ac6241-9a83-4a6d-b464-8fe55418578e",
        "url": "/v2/apps/a7ac6241-9a83-4a6d-b464-8fe55418578e",
        "created_at": "2015-09-30T23:30:56Z",
        "updated_at": "2015-09-30T23:30:56Z"
      },
      "entity": {
        "name": "name-2023",
        "production": false,
        "space_guid": "a5a46885-131a-44fc-b265-0d980cae5244",
        "stack_guid": "f7227253-0133-4007-9345-c95dfc60554d",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "17be2384-7b1d-455f-9c73-0e0e416a1842",
        "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-09-30T23:30:56Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "space_url": "/v2/spaces/a5a46885-131a-44fc-b265-0d980cae5244",
        "stack_url": "/v2/stacks/f7227253-0133-4007-9345-c95dfc60554d",
        "events_url": "/v2/apps/a7ac6241-9a83-4a6d-b464-8fe55418578e/events",
        "service_bindings_url": "/v2/apps/a7ac6241-9a83-4a6d-b464-8fe55418578e/service_bindings",
        "routes_url": "/v2/apps/a7ac6241-9a83-4a6d-b464-8fe55418578e/routes"
      }
    },
    {
      "metadata": {
        "guid": "f72a8d9e-ebf5-44ff-bd45-ecc4b9b64470",
        "url": "/v2/apps/f72a8d9e-ebf5-44ff-bd45-ecc4b9b64470",
        "created_at": "2015-09-30T23:30:56Z",
        "updated_at": "2015-09-30T23:30:56Z"
      },
      "entity": {
        "name": "name-2028",
        "production": false,
        "space_guid": "8809b590-dd9b-4db0-bb20-1bf81df3111a",
        "stack_guid": "808f388f-82d9-4b7b-a3af-9cd3af0be336",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "8aa24593-4b96-473b-8c2e-f490e33fbdf4",
        "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-09-30T23:30:56Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "space_url": "/v2/spaces/8809b590-dd9b-4db0-bb20-1bf81df3111a",
        "stack_url": "/v2/stacks/808f388f-82d9-4b7b-a3af-9cd3af0be336",
        "events_url": "/v2/apps/f72a8d9e-ebf5-44ff-bd45-ecc4b9b64470/events",
        "service_bindings_url": "/v2/apps/f72a8d9e-ebf5-44ff-bd45-ecc4b9b64470/service_bindings",
        "routes_url": "/v2/apps/f72a8d9e-ebf5-44ff-bd45-ecc4b9b64470/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9d824c6a-1732-47f6-9bd4-7577a56fb8c5
Content-Length: 5190
X-Content-Type-Options: nosniff