Home
Version 3
Spaces API

Spaces API

Get Space summary

GET /v2/spaces/:guid/summary

Fields

Name Description Default Valid Values Example Values
guid The guid of the space for which summary is requested
name The name of the space.
apps List of apps that are running in the space
services List of services that are associated with the space

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxNiIsImVtYWlsIjoiZW1haWwtMTU3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzV9.4pdpXiqHRtSgS8bQBWIyT6Hj6bw-VAN1YNvaWGdSbTk
Host: example.org
Cookie: 

Route

GET /v2/spaces/86f2dd4e-112a-46e5-82fc-8f9ea67319de/summary

cURL

curl "https://api.[your-domain.com]/v2/spaces/86f2dd4e-112a-46e5-82fc-8f9ea67319de/summary" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxNiIsImVtYWlsIjoiZW1haWwtMTU3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzV9.4pdpXiqHRtSgS8bQBWIyT6Hj6bw-VAN1YNvaWGdSbTk" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8a35378a-84e4-4d92-9515-4f21ac6c63e9
Content-Length: 1946
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "guid": "86f2dd4e-112a-46e5-82fc-8f9ea67319de",
  "name": "name-1393",
  "apps": [
    {
      "guid": "6e2a68a0-5c27-4741-b9c1-d81735fe64d3",
      "urls": [
        "host-13.domain-43.example.com"
      ],
      "routes": [
        {
          "guid": "6981116f-951b-4fed-95ae-2ec46bfefeae",
          "host": "host-13",
          "domain": {
            "guid": "a4cbd807-f30f-446c-bce7-35ddfd8b36ec",
            "name": "domain-43.example.com"
          }
        }
      ],
      "service_count": 1,
      "service_names": [
        "name-1398"
      ],
      "running_instances": 0,
      "name": "name-1396",
      "production": false,
      "space_guid": "86f2dd4e-112a-46e5-82fc-8f9ea67319de",
      "stack_guid": "ffa38e0d-3005-482d-be78-8b9ab8e848f2",
      "buildpack": null,
      "detected_buildpack": null,
      "environment_json": null,
      "memory": 1024,
      "instances": 1,
      "disk_quota": 1024,
      "state": "STOPPED",
      "version": "4439eb21-29f5-4e56-be73-b4ac350ffa54",
      "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-27T19:14:35Z",
      "detected_start_command": ""
    }
  ],
  "services": [
    {
      "guid": "ecdabcb7-1866-4546-b1f1-4a6b1cf3dcc6",
      "name": "name-1398",
      "bound_app_count": 1,
      "state": "in progress",
      "state_description": "state_description goes here",
      "dashboard_url": null,
      "service_plan": {
        "guid": "9fa76faf-6dce-4df6-a16c-f4e30399d6f0",
        "name": "name-1399",
        "service": {
          "guid": "b05ce103-a3cf-4a61-92d0-f399c1029b0b",
          "label": "label-51",
          "provider": "provider-51",
          "version": "version-35"
        }
      }
    }
  ]
}