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.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OCIsImVtYWlsIjoiZW1haWwtMjE4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTF9.B8ivgOmXAwEcN24V5XWY9nXnNeC6TAvKG-h2q-g4IC0
Host: example.org
Cookie: 

Route

GET /v2/spaces/8cd63fb4-2640-4de5-bb51-a06883635dfd/apps

cURL

curl "https://api.[your-domain.com]/v2/spaces/8cd63fb4-2640-4de5-bb51-a06883635dfd/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3OCIsImVtYWlsIjoiZW1haWwtMjE4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTF9.B8ivgOmXAwEcN24V5XWY9nXnNeC6TAvKG-h2q-g4IC0" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f51e4ca4-48b2-40b2-8e18-bb6aa9b7ce0b
Content-Length: 1617
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "9a2b36c7-1b91-4beb-9494-4a284cd3197c",
        "url": "/v2/apps/9a2b36c7-1b91-4beb-9494-4a284cd3197c",
        "created_at": "2015-01-20T01:52:31+00:00",
        "updated_at": "2015-01-20T01:52:31+00:00"
      },
      "entity": {
        "name": "name-1837",
        "production": false,
        "space_guid": "8cd63fb4-2640-4de5-bb51-a06883635dfd",
        "stack_guid": "1e5a7c3f-7d66-49ba-8fa3-8533ef9d68bc",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "bf4a7981-adce-40ce-abe3-f0bd3f42c0bc",
        "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": "2015-01-20T01:52:31+00:00",
        "detected_start_command": "",
        "space_url": "/v2/spaces/8cd63fb4-2640-4de5-bb51-a06883635dfd",
        "stack_url": "/v2/stacks/1e5a7c3f-7d66-49ba-8fa3-8533ef9d68bc",
        "events_url": "/v2/apps/9a2b36c7-1b91-4beb-9494-4a284cd3197c/events",
        "service_bindings_url": "/v2/apps/9a2b36c7-1b91-4beb-9494-4a284cd3197c/service_bindings",
        "routes_url": "/v2/apps/9a2b36c7-1b91-4beb-9494-4a284cd3197c/routes"
      }
    }
  ]
}