Spaces API

List all Spaces

GET /v2/spaces

Fields

Name	Description	Default	Valid Values	Example Values

Parameters

Name	Description	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.eyJ1c2VyX2lkIjoidWFhLWlkLTIxNCIsImVtYWlsIjoiZW1haWwtMTU4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDZ9.zBmnKM3l1z_umuz-OOA_Hle9jIlzRnMHNAkt7X92v6M
Host: example.org
Cookie:

Route

GET /v2/spaces

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c38a7988-3644-4f49-9063-4f70d1747140
Content-Length: 1462
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "36056f9b-2692-45e6-8be9-08774522587f",
        "url": "/v2/spaces/36056f9b-2692-45e6-8be9-08774522587f",
        "created_at": "2014-11-13T23:38:26+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-768",
        "organization_guid": "118e13ff-866d-4352-ade3-8c239b1ddb63",
        "space_quota_definition_guid": null,
        "organization_url": "/v2/organizations/118e13ff-866d-4352-ade3-8c239b1ddb63",
        "developers_url": "/v2/spaces/36056f9b-2692-45e6-8be9-08774522587f/developers",
        "managers_url": "/v2/spaces/36056f9b-2692-45e6-8be9-08774522587f/managers",
        "auditors_url": "/v2/spaces/36056f9b-2692-45e6-8be9-08774522587f/auditors",
        "apps_url": "/v2/spaces/36056f9b-2692-45e6-8be9-08774522587f/apps",
        "routes_url": "/v2/spaces/36056f9b-2692-45e6-8be9-08774522587f/routes",
        "domains_url": "/v2/spaces/36056f9b-2692-45e6-8be9-08774522587f/domains",
        "service_instances_url": "/v2/spaces/36056f9b-2692-45e6-8be9-08774522587f/service_instances",
        "app_events_url": "/v2/spaces/36056f9b-2692-45e6-8be9-08774522587f/app_events",
        "events_url": "/v2/spaces/36056f9b-2692-45e6-8be9-08774522587f/events",
        "security_groups_url": "/v2/spaces/36056f9b-2692-45e6-8be9-08774522587f/security_groups"
      }
    }
  ]
}