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.eyJ1c2VyX2lkIjoidWFhLWlkLTExMyIsImVtYWlsIjoiZW1haWwtODRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MzgzNzI2MX0.P-9FgYjb2bVS_aXxTOdFasQdXOpkKQf5vZvntM2rn5w
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExMyIsImVtYWlsIjoiZW1haWwtODRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1MzgzNzI2MX0.P-9FgYjb2bVS_aXxTOdFasQdXOpkKQf5vZvntM2rn5w" \
	-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": "14a3f7fc-381b-4992-8d26-f3e06b0459b6",
        "url": "/v2/apps/14a3f7fc-381b-4992-8d26-f3e06b0459b6",
        "created_at": "2016-01-19T19:41:01Z",
        "updated_at": "2016-01-19T19:41:01Z"
      },
      "entity": {
        "name": "name-413",
        "production": false,
        "space_guid": "e79acbf7-70f2-4da3-870b-f862417927f9",
        "stack_guid": "8e150434-a30e-4aac-820a-c03af3985fe3",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "d7a6610d-be02-4831-8d73-57c38c81e015",
        "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-19T19:41:01Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/e79acbf7-70f2-4da3-870b-f862417927f9",
        "stack_url": "/v2/stacks/8e150434-a30e-4aac-820a-c03af3985fe3",
        "events_url": "/v2/apps/14a3f7fc-381b-4992-8d26-f3e06b0459b6/events",
        "service_bindings_url": "/v2/apps/14a3f7fc-381b-4992-8d26-f3e06b0459b6/service_bindings",
        "routes_url": "/v2/apps/14a3f7fc-381b-4992-8d26-f3e06b0459b6/routes"
      }
    },
    {
      "metadata": {
        "guid": "377e1395-a63f-422e-b6d2-93317576fe59",
        "url": "/v2/apps/377e1395-a63f-422e-b6d2-93317576fe59",
        "created_at": "2016-01-19T19:41:01Z",
        "updated_at": "2016-01-19T19:41:01Z"
      },
      "entity": {
        "name": "name-418",
        "production": false,
        "space_guid": "96fa8304-b06f-43a3-a192-7f064b60e83e",
        "stack_guid": "636cd8af-79bc-4429-808f-b5def94003ad",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "e1c40e0c-9a61-49c7-a796-8825f2ae5dfa",
        "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-19T19:41:01Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/96fa8304-b06f-43a3-a192-7f064b60e83e",
        "stack_url": "/v2/stacks/636cd8af-79bc-4429-808f-b5def94003ad",
        "events_url": "/v2/apps/377e1395-a63f-422e-b6d2-93317576fe59/events",
        "service_bindings_url": "/v2/apps/377e1395-a63f-422e-b6d2-93317576fe59/service_bindings",
        "routes_url": "/v2/apps/377e1395-a63f-422e-b6d2-93317576fe59/routes"
      }
    },
    {
      "metadata": {
        "guid": "bc5599b7-9361-42e9-8527-7af3f25c8f13",
        "url": "/v2/apps/bc5599b7-9361-42e9-8527-7af3f25c8f13",
        "created_at": "2016-01-19T19:41:01Z",
        "updated_at": "2016-01-19T19:41:01Z"
      },
      "entity": {
        "name": "name-408",
        "production": false,
        "space_guid": "411ff9fb-1b10-4591-bfae-4b64c831e349",
        "stack_guid": "f981914e-c40c-4fdb-8f22-6864ab0f58be",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "5eb9ca7d-3b1e-4455-82eb-53aab58ea5fb",
        "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-19T19:41:01Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/411ff9fb-1b10-4591-bfae-4b64c831e349",
        "stack_url": "/v2/stacks/f981914e-c40c-4fdb-8f22-6864ab0f58be",
        "events_url": "/v2/apps/bc5599b7-9361-42e9-8527-7af3f25c8f13/events",
        "service_bindings_url": "/v2/apps/bc5599b7-9361-42e9-8527-7af3f25c8f13/service_bindings",
        "routes_url": "/v2/apps/bc5599b7-9361-42e9-8527-7af3f25c8f13/routes"
      }
    }
  ]
}

Headers

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