Home
Version 3
Spaces API

Spaces API

List all Spaces

GET /v2/spaces

Request

Route

GET /v2/spaces

Parameters

Name Description Valid Values Example Values
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name, organization_guid, developer_guid, app_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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNCIsImVtYWlsIjoiZW1haWwtODNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNjYzMzkwMH0.r_0mH_C0DojzU_EuLz8U142F8-57mlft9WUDLRDAr5s
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/spaces" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNCIsImVtYWlsIjoiZW1haWwtODNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNjYzMzkwMH0.r_0mH_C0DojzU_EuLz8U142F8-57mlft9WUDLRDAr5s" \
	-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": "33d252fb-7a44-4c4b-a904-877fc2aa89d8",
        "url": "/v2/spaces/33d252fb-7a44-4c4b-a904-877fc2aa89d8",
        "created_at": "2015-03-10T23:11:40Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-318",
        "organization_guid": "f1740696-7a0d-4bef-ab17-ecc1bb4a7653",
        "space_quota_definition_guid": null,
        "organization_url": "/v2/organizations/f1740696-7a0d-4bef-ab17-ecc1bb4a7653",
        "developers_url": "/v2/spaces/33d252fb-7a44-4c4b-a904-877fc2aa89d8/developers",
        "managers_url": "/v2/spaces/33d252fb-7a44-4c4b-a904-877fc2aa89d8/managers",
        "auditors_url": "/v2/spaces/33d252fb-7a44-4c4b-a904-877fc2aa89d8/auditors",
        "apps_url": "/v2/spaces/33d252fb-7a44-4c4b-a904-877fc2aa89d8/apps",
        "routes_url": "/v2/spaces/33d252fb-7a44-4c4b-a904-877fc2aa89d8/routes",
        "domains_url": "/v2/spaces/33d252fb-7a44-4c4b-a904-877fc2aa89d8/domains",
        "service_instances_url": "/v2/spaces/33d252fb-7a44-4c4b-a904-877fc2aa89d8/service_instances",
        "app_events_url": "/v2/spaces/33d252fb-7a44-4c4b-a904-877fc2aa89d8/app_events",
        "events_url": "/v2/spaces/33d252fb-7a44-4c4b-a904-877fc2aa89d8/events",
        "security_groups_url": "/v2/spaces/33d252fb-7a44-4c4b-a904-877fc2aa89d8/security_groups"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 06e781b2-cc12-43ac-9639-d87c5153b998
Content-Length: 1457
X-Content-Type-Options: nosniff