Home
Version 3
Spaces API

Spaces API

List all Apps for the Space

GET /v2/spaces/:guid/apps

Request

Route

GET /v2/spaces/ee542825-80b6-46e1-a04a-992dcf22c359/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.eyJ1c2VyX2lkIjoidWFhLWlkLTkyIiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM2ODI5Nzc3fQ.MmrK7Qt6clPknXHyaJSIRJpbxfe5WflYRTHUh0gcnE4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/spaces/ee542825-80b6-46e1-a04a-992dcf22c359/apps" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTkyIiwiZW1haWwiOiJlbWFpbC01NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM2ODI5Nzc3fQ.MmrK7Qt6clPknXHyaJSIRJpbxfe5WflYRTHUh0gcnE4" \
	-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": "7ce06d51-3bb2-4b65-af41-746ec7eb934f",
        "url": "/v2/apps/7ce06d51-3bb2-4b65-af41-746ec7eb934f",
        "created_at": "2015-07-06T23:22:57Z",
        "updated_at": "2015-07-06T23:22:57Z"
      },
      "entity": {
        "name": "name-272",
        "production": false,
        "space_guid": "ee542825-80b6-46e1-a04a-992dcf22c359",
        "stack_guid": "da139d38-76c2-4509-b105-d4ae5eb1027d",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "ba0accd1-940c-422c-9261-9037fbf7fcdb",
        "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-07-06T23:22:57Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "docker_credentials_json": {
          "redacted_message": "[PRIVATE DATA HIDDEN]"
        },
        "space_url": "/v2/spaces/ee542825-80b6-46e1-a04a-992dcf22c359",
        "stack_url": "/v2/stacks/da139d38-76c2-4509-b105-d4ae5eb1027d",
        "events_url": "/v2/apps/7ce06d51-3bb2-4b65-af41-746ec7eb934f/events",
        "service_bindings_url": "/v2/apps/7ce06d51-3bb2-4b65-af41-746ec7eb934f/service_bindings",
        "routes_url": "/v2/apps/7ce06d51-3bb2-4b65-af41-746ec7eb934f/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 197d0f34-ab9e-4137-843e-15a97c94cccf
Content-Length: 1799
X-Content-Type-Options: nosniff