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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTcxIiwiZW1haWwiOiJlbWFpbC0zOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU0NDUxNjA4fQ.mLWmPVEf7E6UQ0N9cfe5lA16ovtz9kacU7kHYRaMZ2E
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTcxIiwiZW1haWwiOiJlbWFpbC0zOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU0NDUxNjA4fQ.mLWmPVEf7E6UQ0N9cfe5lA16ovtz9kacU7kHYRaMZ2E" \
	-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": "8a24297c-8489-4d99-9a27-b12d217782c0",
        "url": "/v2/apps/8a24297c-8489-4d99-9a27-b12d217782c0",
        "created_at": "2016-01-26T22:20:08Z",
        "updated_at": "2016-01-26T22:20:08Z"
      },
      "entity": {
        "name": "name-215",
        "production": false,
        "space_guid": "e98f80c0-91de-4a8d-8fab-02c6bb2c0dc1",
        "stack_guid": "41bfc9c6-9349-4adf-a852-104dadd63ca4",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "81a46896-10f0-40a8-9314-357a6c7f35da",
        "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-01-26T22:20:08Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/e98f80c0-91de-4a8d-8fab-02c6bb2c0dc1",
        "stack_url": "/v2/stacks/41bfc9c6-9349-4adf-a852-104dadd63ca4",
        "events_url": "/v2/apps/8a24297c-8489-4d99-9a27-b12d217782c0/events",
        "service_bindings_url": "/v2/apps/8a24297c-8489-4d99-9a27-b12d217782c0/service_bindings",
        "routes_url": "/v2/apps/8a24297c-8489-4d99-9a27-b12d217782c0/routes"
      }
    },
    {
      "metadata": {
        "guid": "d944c87e-6184-4b5f-99f9-661dc7381bf8",
        "url": "/v2/apps/d944c87e-6184-4b5f-99f9-661dc7381bf8",
        "created_at": "2016-01-26T22:20:08Z",
        "updated_at": "2016-01-26T22:20:08Z"
      },
      "entity": {
        "name": "name-220",
        "production": false,
        "space_guid": "c848d294-9c77-43ec-a5d7-8c416343cc51",
        "stack_guid": "cbab057b-48db-4781-aa3e-a3c33573a3d4",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "eb1eddfd-7b0b-4a92-9823-cce955b9625f",
        "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-01-26T22:20:08Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/c848d294-9c77-43ec-a5d7-8c416343cc51",
        "stack_url": "/v2/stacks/cbab057b-48db-4781-aa3e-a3c33573a3d4",
        "events_url": "/v2/apps/d944c87e-6184-4b5f-99f9-661dc7381bf8/events",
        "service_bindings_url": "/v2/apps/d944c87e-6184-4b5f-99f9-661dc7381bf8/service_bindings",
        "routes_url": "/v2/apps/d944c87e-6184-4b5f-99f9-661dc7381bf8/routes"
      }
    },
    {
      "metadata": {
        "guid": "ea957179-97f4-438b-a20d-f504f1305045",
        "url": "/v2/apps/ea957179-97f4-438b-a20d-f504f1305045",
        "created_at": "2016-01-26T22:20:08Z",
        "updated_at": "2016-01-26T22:20:08Z"
      },
      "entity": {
        "name": "name-210",
        "production": false,
        "space_guid": "6edd5300-92c8-46be-a3ca-d07cfe5bfb74",
        "stack_guid": "a29ccdc4-3241-4b47-9703-b07ad37de0a3",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "ee2c448f-97aa-4733-ae0a-0e143671c4cb",
        "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-01-26T22:20:08Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/6edd5300-92c8-46be-a3ca-d07cfe5bfb74",
        "stack_url": "/v2/stacks/a29ccdc4-3241-4b47-9703-b07ad37de0a3",
        "events_url": "/v2/apps/ea957179-97f4-438b-a20d-f504f1305045/events",
        "service_bindings_url": "/v2/apps/ea957179-97f4-438b-a20d-f504f1305045/service_bindings",
        "routes_url": "/v2/apps/ea957179-97f4-438b-a20d-f504f1305045/routes"
      }
    }
  ]
}

Headers

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