Home
Version 3
Spaces API

Spaces API

List all Apps for the Space

GET /v2/spaces/:guid/apps

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
guid The guid of the Space
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name, space_guid, organization_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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2IiwiZW1haWwiOiJlbWFpbC0zMEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE5OTg5OTYyfQ.neoKwgY9aPaHFpIcwS7yE0amuRxWf-s9F-pYnQs8iiE
Host: example.org
Cookie: 

Route

GET /v2/spaces/89f55328-8922-431e-9b7d-7b38e4a6df7a/apps

cURL

curl "https://api.[your-domain.com]/v2/spaces/89f55328-8922-431e-9b7d-7b38e4a6df7a/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2IiwiZW1haWwiOiJlbWFpbC0zMEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE5OTg5OTYyfQ.neoKwgY9aPaHFpIcwS7yE0amuRxWf-s9F-pYnQs8iiE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6c855bb4-2ac4-40d5-8d6c-996025653a38
Content-Length: 1615
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "60801b66-d72b-4458-af9c-99d388f74e4c",
        "url": "/v2/apps/60801b66-d72b-4458-af9c-99d388f74e4c",
        "created_at": "2014-12-24T01:39:22+00:00",
        "updated_at": "2014-12-24T01:39:22+00:00"
      },
      "entity": {
        "name": "name-75",
        "production": false,
        "space_guid": "89f55328-8922-431e-9b7d-7b38e4a6df7a",
        "stack_guid": "3b111f17-31c2-4244-afc5-2a86ad2c4295",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "0dec4121-3bc3-42fc-800d-3deee9274069",
        "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,
        "docker_image": null,
        "package_updated_at": "2014-12-24T01:39:22+00:00",
        "detected_start_command": "",
        "space_url": "/v2/spaces/89f55328-8922-431e-9b7d-7b38e4a6df7a",
        "stack_url": "/v2/stacks/3b111f17-31c2-4244-afc5-2a86ad2c4295",
        "events_url": "/v2/apps/60801b66-d72b-4458-af9c-99d388f74e4c/events",
        "service_bindings_url": "/v2/apps/60801b66-d72b-4458-af9c-99d388f74e4c/service_bindings",
        "routes_url": "/v2/apps/60801b66-d72b-4458-af9c-99d388f74e4c/routes"
      }
    }
  ]
}