Home
Version 3
Spaces API

Spaces API

List all Spaces

GET /v2/spaces

Fields

Name Description Default Valid Values Example Values

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3MCIsImVtYWlsIjoiZW1haWwtMjEwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTB9.xGmmSxQJii2Mtvs7bI57Rn8rbt7Ia61i5vD6fDt7EbQ
Host: example.org
Cookie: 

Route

GET /v2/spaces

cURL

curl "https://api.[your-domain.com]/v2/spaces" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3MCIsImVtYWlsIjoiZW1haWwtMjEwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTB9.xGmmSxQJii2Mtvs7bI57Rn8rbt7Ia61i5vD6fDt7EbQ" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ec640f4b-8168-4f9c-898f-893f66a6a530
Content-Length: 1463
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "d4ba7780-d921-4c21-8b6b-f7ac57e41f3e",
        "url": "/v2/spaces/d4ba7780-d921-4c21-8b6b-f7ac57e41f3e",
        "created_at": "2015-01-20T01:52:30+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-1805",
        "organization_guid": "b316f719-2d10-477e-b507-8f2078c2dd52",
        "space_quota_definition_guid": null,
        "organization_url": "/v2/organizations/b316f719-2d10-477e-b507-8f2078c2dd52",
        "developers_url": "/v2/spaces/d4ba7780-d921-4c21-8b6b-f7ac57e41f3e/developers",
        "managers_url": "/v2/spaces/d4ba7780-d921-4c21-8b6b-f7ac57e41f3e/managers",
        "auditors_url": "/v2/spaces/d4ba7780-d921-4c21-8b6b-f7ac57e41f3e/auditors",
        "apps_url": "/v2/spaces/d4ba7780-d921-4c21-8b6b-f7ac57e41f3e/apps",
        "routes_url": "/v2/spaces/d4ba7780-d921-4c21-8b6b-f7ac57e41f3e/routes",
        "domains_url": "/v2/spaces/d4ba7780-d921-4c21-8b6b-f7ac57e41f3e/domains",
        "service_instances_url": "/v2/spaces/d4ba7780-d921-4c21-8b6b-f7ac57e41f3e/service_instances",
        "app_events_url": "/v2/spaces/d4ba7780-d921-4c21-8b6b-f7ac57e41f3e/app_events",
        "events_url": "/v2/spaces/d4ba7780-d921-4c21-8b6b-f7ac57e41f3e/events",
        "security_groups_url": "/v2/spaces/d4ba7780-d921-4c21-8b6b-f7ac57e41f3e/security_groups"
      }
    }
  ]
}