Home
Version 3
Spaces API

Spaces API

Get Space summary

GET /v2/spaces/:guid/summary

Request

Route

GET /v2/spaces/218fb86d-0904-4bc4-b529-a8475c6b5083/summary

Body

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwMiIsImVtYWlsIjoiZW1haWwtMjA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2OTF9.NwyTxQlgIdQVBIumK1neXAYKwnshFIT8PoHTxCQDTfE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/spaces/218fb86d-0904-4bc4-b529-a8475c6b5083/summary" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwMiIsImVtYWlsIjoiZW1haWwtMjA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2OTF9.NwyTxQlgIdQVBIumK1neXAYKwnshFIT8PoHTxCQDTfE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "guid": "218fb86d-0904-4bc4-b529-a8475c6b5083",
  "name": "name-982",
  "apps": [
    {
      "guid": "68cbd7ab-edf0-470b-ac80-9846c9109f18",
      "urls": [
        "host-25.domain-48.example.com"
      ],
      "routes": [
        {
          "guid": "7a39e073-8f6b-41e0-a458-2f54ae74dbf9",
          "host": "host-25",
          "domain": {
            "guid": "1a5a5597-4a60-411f-9a19-b799006b6e77",
            "name": "domain-48.example.com"
          }
        }
      ],
      "service_count": 1,
      "service_names": [
        "name-987"
      ],
      "running_instances": 0,
      "name": "name-985",
      "production": false,
      "space_guid": "218fb86d-0904-4bc4-b529-a8475c6b5083",
      "stack_guid": "b7db02a1-9daa-4b02-8a79-713b010b8297",
      "buildpack": null,
      "detected_buildpack": null,
      "environment_json": null,
      "memory": 1024,
      "instances": 1,
      "disk_quota": 1024,
      "state": "STOPPED",
      "version": "6a596ba0-0ed9-44a3-83ad-f9548aa715f2",
      "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-12-22T18:28:11Z",
      "detected_start_command": "",
      "enable_ssh": true,
      "docker_credentials_json": {
        "redacted_message": "[PRIVATE DATA HIDDEN]"
      },
      "ports": null
    }
  ],
  "services": [
    {
      "guid": "4f737dcd-17db-4a29-93fc-aef6ed076e14",
      "name": "name-987",
      "bound_app_count": 1,
      "last_operation": null,
      "dashboard_url": null,
      "service_plan": {
        "guid": "a81fd5f9-faf8-41fb-aa10-16dda6a4c998",
        "name": "name-988",
        "service": {
          "guid": "3dd370f0-4ba9-48c8-b57f-1157cfc1c17d",
          "label": "label-41",
          "provider": null,
          "version": null
        }
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 2073
X-Content-Type-Options: nosniff