Home
Version 3
Spaces API

Spaces API

List all Services for the Space

GET /v2/spaces/:guid/services

Request

Route

GET /v2/spaces/8e827eb3-baf5-4c36-ad7a-e0179fe5839f/services

Parameters

Name Description Valid Values Example Values
guid The guid of the Space
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: active, label, provider, service_broker_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.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MyIsImVtYWlsIjoiZW1haWwtMTAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxMzl9.tZw6srELU0P26wjaexgNnBbcN5dJ5xVETzNPdKryQnk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/spaces/8e827eb3-baf5-4c36-ad7a-e0179fe5839f/services" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MyIsImVtYWlsIjoiZW1haWwtMTAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxMzl9.tZw6srELU0P26wjaexgNnBbcN5dJ5xVETzNPdKryQnk" \
	-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": "b20d67c6-a410-4fa4-9e95-34c5a298861c",
        "url": "/v2/services/b20d67c6-a410-4fa4-9e95-34c5a298861c",
        "created_at": "2015-04-15T00:55:39Z",
        "updated_at": null
      },
      "entity": {
        "label": "label-23",
        "provider": null,
        "url": null,
        "description": "desc-59",
        "long_description": null,
        "version": null,
        "info_url": null,
        "active": true,
        "bindable": true,
        "unique_id": "36d039de-881f-4c99-802d-94756c08a0b5",
        "extra": null,
        "tags": [

        ],
        "requires": [

        ],
        "documentation_url": null,
        "service_broker_guid": "b0160c1d-0333-41e6-9e05-c5ff9743a901",
        "plan_updateable": false,
        "service_plans_url": "/v2/services/b20d67c6-a410-4fa4-9e95-34c5a298861c/service_plans"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6bcbf3b9-2f4f-46f4-a694-0f1d8df708e0
Content-Length: 998
X-Content-Type-Options: nosniff