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.eyJ1c2VyX2lkIjoidWFhLWlkLTUxIiwiZW1haWwiOiJlbWFpbC01MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU2NDUyMjIzfQ.O4zkCjk90IGhvRX1ozzq_ONALZ6snLiMDPn6e78ceiE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTUxIiwiZW1haWwiOiJlbWFpbC01MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU2NDUyMjIzfQ.O4zkCjk90IGhvRX1ozzq_ONALZ6snLiMDPn6e78ceiE" \
	-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": "16a825a0-0cb0-4ad4-b5d1-d7e1b09a70af",
        "url": "/v2/apps/16a825a0-0cb0-4ad4-b5d1-d7e1b09a70af",
        "created_at": "2016-02-19T02:03:43Z",
        "updated_at": "2016-02-19T02:03:43Z"
      },
      "entity": {
        "name": "name-223",
        "production": false,
        "space_guid": "6800bff3-cba8-44ad-bc80-a4f491b4ea85",
        "stack_guid": "ef004e60-b807-4204-a2c2-f8a474d6e796",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "af943b7c-8fe1-4354-b0dc-a15081afa487",
        "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-02-19T02:03:43Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/6800bff3-cba8-44ad-bc80-a4f491b4ea85",
        "stack_url": "/v2/stacks/ef004e60-b807-4204-a2c2-f8a474d6e796",
        "events_url": "/v2/apps/16a825a0-0cb0-4ad4-b5d1-d7e1b09a70af/events",
        "service_bindings_url": "/v2/apps/16a825a0-0cb0-4ad4-b5d1-d7e1b09a70af/service_bindings",
        "routes_url": "/v2/apps/16a825a0-0cb0-4ad4-b5d1-d7e1b09a70af/routes",
        "route_mappings_url": "/v2/apps/16a825a0-0cb0-4ad4-b5d1-d7e1b09a70af/route_mappings"
      }
    },
    {
      "metadata": {
        "guid": "b469756c-d595-4e0f-8411-d23e2da68b43",
        "url": "/v2/apps/b469756c-d595-4e0f-8411-d23e2da68b43",
        "created_at": "2016-02-19T02:03:43Z",
        "updated_at": "2016-02-19T02:03:43Z"
      },
      "entity": {
        "name": "name-213",
        "production": false,
        "space_guid": "2d3bf5c8-3177-4c4c-970f-f62fc748bdb0",
        "stack_guid": "3da2c186-a90d-45cb-87ae-6384ed125f2b",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "eccb045d-7458-4c55-bbae-651c9f401614",
        "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-02-19T02:03:43Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/2d3bf5c8-3177-4c4c-970f-f62fc748bdb0",
        "stack_url": "/v2/stacks/3da2c186-a90d-45cb-87ae-6384ed125f2b",
        "events_url": "/v2/apps/b469756c-d595-4e0f-8411-d23e2da68b43/events",
        "service_bindings_url": "/v2/apps/b469756c-d595-4e0f-8411-d23e2da68b43/service_bindings",
        "routes_url": "/v2/apps/b469756c-d595-4e0f-8411-d23e2da68b43/routes",
        "route_mappings_url": "/v2/apps/b469756c-d595-4e0f-8411-d23e2da68b43/route_mappings"
      }
    },
    {
      "metadata": {
        "guid": "d7455542-a2e7-4825-9c30-d4af573187d5",
        "url": "/v2/apps/d7455542-a2e7-4825-9c30-d4af573187d5",
        "created_at": "2016-02-19T02:03:43Z",
        "updated_at": "2016-02-19T02:03:43Z"
      },
      "entity": {
        "name": "name-218",
        "production": false,
        "space_guid": "7c94f86a-c877-425d-8a56-feb4bb4c81d0",
        "stack_guid": "c7fedb1a-7cb0-43fd-be62-9cc803401a20",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "32f8fbc2-94dd-484c-b2c0-35e2db0be5ec",
        "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-02-19T02:03:43Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "ports": null,
        "space_url": "/v2/spaces/7c94f86a-c877-425d-8a56-feb4bb4c81d0",
        "stack_url": "/v2/stacks/c7fedb1a-7cb0-43fd-be62-9cc803401a20",
        "events_url": "/v2/apps/d7455542-a2e7-4825-9c30-d4af573187d5/events",
        "service_bindings_url": "/v2/apps/d7455542-a2e7-4825-9c30-d4af573187d5/service_bindings",
        "routes_url": "/v2/apps/d7455542-a2e7-4825-9c30-d4af573187d5/routes",
        "route_mappings_url": "/v2/apps/d7455542-a2e7-4825-9c30-d4af573187d5/route_mappings"
      }
    }
  ]
}

Headers

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