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
order-by Parameter to order results by
  • name
  • id
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.eyJ1c2VyX2lkIjoidWFhLWlkLTI4MyIsImVtYWlsIjoiZW1haWwtMTc5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3MTl9.qToRczZYvlml5vW_tSnmHmRbLNi3Zqpy1TM-ctm5CBQ
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/spaces" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4MyIsImVtYWlsIjoiZW1haWwtMTc5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3MTl9.qToRczZYvlml5vW_tSnmHmRbLNi3Zqpy1TM-ctm5CBQ" \
	-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": "93db6577-88fd-4c5c-a822-f187eecc516b",
        "url": "/v2/spaces/93db6577-88fd-4c5c-a822-f187eecc516b",
        "created_at": "2016-05-12T00:45:18Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1656",
        "organization_guid": "7c225d62-82c5-447b-8630-8e663ac74e58",
        "space_quota_definition_guid": null,
        "allow_ssh": true,
        "organization_url": "/v2/organizations/7c225d62-82c5-447b-8630-8e663ac74e58",
        "developers_url": "/v2/spaces/93db6577-88fd-4c5c-a822-f187eecc516b/developers",
        "managers_url": "/v2/spaces/93db6577-88fd-4c5c-a822-f187eecc516b/managers",
        "auditors_url": "/v2/spaces/93db6577-88fd-4c5c-a822-f187eecc516b/auditors",
        "apps_url": "/v2/spaces/93db6577-88fd-4c5c-a822-f187eecc516b/apps",
        "routes_url": "/v2/spaces/93db6577-88fd-4c5c-a822-f187eecc516b/routes",
        "domains_url": "/v2/spaces/93db6577-88fd-4c5c-a822-f187eecc516b/domains",
        "service_instances_url": "/v2/spaces/93db6577-88fd-4c5c-a822-f187eecc516b/service_instances",
        "app_events_url": "/v2/spaces/93db6577-88fd-4c5c-a822-f187eecc516b/app_events",
        "events_url": "/v2/spaces/93db6577-88fd-4c5c-a822-f187eecc516b/events",
        "security_groups_url": "/v2/spaces/93db6577-88fd-4c5c-a822-f187eecc516b/security_groups"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6fcfd37b-6281-41f6-8973-eabb9dc31921
Content-Length: 1485
X-Content-Type-Options: nosniff