GET /v2/apps
| 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 |
|
|
| 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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OSIsImVtYWlsIjoiZW1haWwtMTgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2MzZ9.doNzzBeODu1qJvjZy3N3u_S_2CykXT04ihykP6iQZUQ Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OSIsImVtYWlsIjoiZW1haWwtMTgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2MzZ9.doNzzBeODu1qJvjZy3N3u_S_2CykXT04ihykP6iQZUQ" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
| Name | Description | Valid Values | Example Values |
|---|---|---|---|
| name | The name of the app. |
|
|
| memory | The amount of memory each instance should have. In megabytes. |
|
|
| instances | The number of instances of the app to run. To ensure optimal availability, ensure there are at least 2 instances. |
|
|
| disk_quota | The maximum amount of disk available to an instance of an app. In megabytes. |
|
|
| space_guid | The guid of the associated space. |
|
|
| stack_guid | The guid of the associated stack. |
|
|
| state | The current desired state of the app. One of STOPPED or 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. |
|
|
| health_check_type | Type of health check to perform. 'none' is deprecated and an alias to 'process'. |
|
|
| health_check_timeout | Timeout for health checking of an staged app when starting up |
|
|
| diego | Use diego to stage and to run when available |
|
|
| enable_ssh | Enable SSHing into the app. Supported for Diego only. |
|
|
| docker_image | Name of the Docker image containing the app |
|
|
| docker_credentials_json | Docker credentials for pulling docker image. |
|
|
| 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. |
|
|
| console | Open the console port for the app (at $CONSOLE_PORT). |
|
|
| debug | Open the debug port for the app (at $DEBUG_PORT). |
|
|
| 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. Overwrites previously configured ports. Ports must be in range 1024-65535. Supported for Diego only. |
|
|
{
"total_results": 3,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "1fbe29f8-1314-4137-9797-b6af084e7cf8",
"url": "/v2/apps/1fbe29f8-1314-4137-9797-b6af084e7cf8",
"created_at": "2016-04-16T01:23:55Z",
"updated_at": "2016-04-16T01:23:55Z"
},
"entity": {
"name": "name-806",
"production": false,
"space_guid": "21424113-cbe0-463b-b7d9-e0d1f6b5fb11",
"stack_guid": "0067e1b8-8883-4e7f-8879-466ba496a42f",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "8d8a48c0-a3a9-4043-a294-5cc88881efbf",
"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-04-16T01:23:55Z",
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"ports": null,
"space_url": "/v2/spaces/21424113-cbe0-463b-b7d9-e0d1f6b5fb11",
"stack_url": "/v2/stacks/0067e1b8-8883-4e7f-8879-466ba496a42f",
"routes_url": "/v2/apps/1fbe29f8-1314-4137-9797-b6af084e7cf8/routes",
"events_url": "/v2/apps/1fbe29f8-1314-4137-9797-b6af084e7cf8/events",
"service_bindings_url": "/v2/apps/1fbe29f8-1314-4137-9797-b6af084e7cf8/service_bindings",
"route_mappings_url": "/v2/apps/1fbe29f8-1314-4137-9797-b6af084e7cf8/route_mappings"
}
},
{
"metadata": {
"guid": "58980381-e9ed-4096-bb33-4717e2828105",
"url": "/v2/apps/58980381-e9ed-4096-bb33-4717e2828105",
"created_at": "2016-04-16T01:23:55Z",
"updated_at": "2016-04-16T01:23:55Z"
},
"entity": {
"name": "name-801",
"production": false,
"space_guid": "3e28ce15-f348-44d3-bf18-f4f579fd2a6e",
"stack_guid": "5727358b-3934-4a1d-bf9c-245a73b50bc6",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "eec50efb-f055-4ac8-b543-3c16dfe5e295",
"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-04-16T01:23:55Z",
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"ports": null,
"space_url": "/v2/spaces/3e28ce15-f348-44d3-bf18-f4f579fd2a6e",
"stack_url": "/v2/stacks/5727358b-3934-4a1d-bf9c-245a73b50bc6",
"routes_url": "/v2/apps/58980381-e9ed-4096-bb33-4717e2828105/routes",
"events_url": "/v2/apps/58980381-e9ed-4096-bb33-4717e2828105/events",
"service_bindings_url": "/v2/apps/58980381-e9ed-4096-bb33-4717e2828105/service_bindings",
"route_mappings_url": "/v2/apps/58980381-e9ed-4096-bb33-4717e2828105/route_mappings"
}
},
{
"metadata": {
"guid": "8bf2ba3a-8051-425e-bf8d-4669e19a28d5",
"url": "/v2/apps/8bf2ba3a-8051-425e-bf8d-4669e19a28d5",
"created_at": "2016-04-16T01:23:55Z",
"updated_at": "2016-04-16T01:23:55Z"
},
"entity": {
"name": "name-796",
"production": false,
"space_guid": "bfcd9cf1-bbb5-4153-8543-fc33b652939e",
"stack_guid": "ec4fb366-b223-4e5c-a2c2-de8151ab91c5",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "4d241f8e-b1b5-4e2e-b8d6-363ddedde671",
"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-04-16T01:23:55Z",
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"ports": null,
"space_url": "/v2/spaces/bfcd9cf1-bbb5-4153-8543-fc33b652939e",
"stack_url": "/v2/stacks/ec4fb366-b223-4e5c-a2c2-de8151ab91c5",
"routes_url": "/v2/apps/8bf2ba3a-8051-425e-bf8d-4669e19a28d5/routes",
"events_url": "/v2/apps/8bf2ba3a-8051-425e-bf8d-4669e19a28d5/events",
"service_bindings_url": "/v2/apps/8bf2ba3a-8051-425e-bf8d-4669e19a28d5/service_bindings",
"route_mappings_url": "/v2/apps/8bf2ba3a-8051-425e-bf8d-4669e19a28d5/route_mappings"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 2299d72d-4171-4edb-8396-1995c23f6727 Content-Length: 5538 X-Content-Type-Options: nosniff