Home
Version 3
Spaces API

Spaces API

List all Apps for the Space

GET /v2/spaces/:guid/apps

Request

Route

GET /v2/spaces/19ced979-7fd4-423d-b848-1f89bc6cc57c/apps

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, 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.eyJ1c2VyX2lkIjoidWFhLWlkLTI3IiwiZW1haWwiOiJlbWFpbC0xNkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQyNjAxNTI1fQ.ap0zdr5LcmRkwPxv0wzqMUNj9fGqyZRthKu_N2NNoII
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/spaces/19ced979-7fd4-423d-b848-1f89bc6cc57c/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3IiwiZW1haWwiOiJlbWFpbC0xNkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQyNjAxNTI1fQ.ap0zdr5LcmRkwPxv0wzqMUNj9fGqyZRthKu_N2NNoII" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "a9580c9e-ed8f-4dc7-b5a0-f38ed84777a0",
        "url": "/v2/apps/a9580c9e-ed8f-4dc7-b5a0-f38ed84777a0",
        "created_at": "2015-09-11T18:38:45Z",
        "updated_at": "2015-09-11T18:38:45Z"
      },
      "entity": {
        "name": "name-56",
        "production": false,
        "space_guid": "19ced979-7fd4-423d-b848-1f89bc6cc57c",
        "stack_guid": "2478bcfb-abd9-47bd-aaf5-e3b797b57788",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "cd5e5521-01df-49b9-a33c-3009e5783da2",
        "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": "2015-09-11T18:38:45Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "space_url": "/v2/spaces/19ced979-7fd4-423d-b848-1f89bc6cc57c",
        "stack_url": "/v2/stacks/2478bcfb-abd9-47bd-aaf5-e3b797b57788",
        "events_url": "/v2/apps/a9580c9e-ed8f-4dc7-b5a0-f38ed84777a0/events",
        "service_bindings_url": "/v2/apps/a9580c9e-ed8f-4dc7-b5a0-f38ed84777a0/service_bindings",
        "routes_url": "/v2/apps/a9580c9e-ed8f-4dc7-b5a0-f38ed84777a0/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 64164243-a185-456b-a206-8a844f9e650d
Content-Length: 1798
X-Content-Type-Options: nosniff