Home
Version 3
Spaces API

Spaces API

List all Service Instances for the Space

GET /v2/spaces/:guid/service_instances

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
guid The guid of the Space
return_user_provided_service_instances When 'true', include user provided service instances.
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name, space_guid, service_plan_guid, service_binding_guid, gateway_name, organization_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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1OCIsImVtYWlsIjoiZW1haWwtMTc5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNzJ9.EsBDy5ZxpyW-jUxe1zAeYURcyJ4rhD2fXWSc_R_fhzM
Host: example.org
Cookie: 

Route

GET /v2/spaces/bfc709f0-5789-4f03-93f5-f6ce5456ee58/service_instances

cURL

curl "https://api.[your-domain.com]/v2/spaces/bfc709f0-5789-4f03-93f5-f6ce5456ee58/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1OCIsImVtYWlsIjoiZW1haWwtMTc5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNzJ9.EsBDy5ZxpyW-jUxe1zAeYURcyJ4rhD2fXWSc_R_fhzM" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6283ce01-7d6b-4784-a9a8-e58b5b9d541d
Content-Length: 1023
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "bb042a59-f7a2-441e-8038-15a2303544bc",
        "url": "/v2/service_instances/bb042a59-f7a2-441e-8038-15a2303544bc",
        "created_at": "2015-02-10T01:42:52Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1359",
        "credentials": {
          "creds-key-374": "creds-val-374"
        },
        "service_plan_guid": "cbd10c9e-f02c-4162-b232-448ffb0105f4",
        "space_guid": "bfc709f0-5789-4f03-93f5-f6ce5456ee58",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": null,
        "space_url": "/v2/spaces/bfc709f0-5789-4f03-93f5-f6ce5456ee58",
        "service_plan_url": "/v2/service_plans/cbd10c9e-f02c-4162-b232-448ffb0105f4",
        "service_bindings_url": "/v2/service_instances/bb042a59-f7a2-441e-8038-15a2303544bc/service_bindings"
      }
    }
  ]
}