Home
Version 3
Spaces API

Spaces API

List all Service Instances for the Space

GET /v2/spaces/:guid/service_instances

Request

Route

GET /v2/spaces/c01023d1-19df-4973-ab5b-65104578adb2/service_instances

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, service_key_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.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MSIsImVtYWlsIjoiZW1haWwtMTMzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzIzMTM2MTR9.WgnIhxkoUogVVMorz5X0A7e3_i91Zsq5Gm9kddqhoyA
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/spaces/c01023d1-19df-4973-ab5b-65104578adb2/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MSIsImVtYWlsIjoiZW1haWwtMTMzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzIzMTM2MTR9.WgnIhxkoUogVVMorz5X0A7e3_i91Zsq5Gm9kddqhoyA" \
	-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": "242243f9-dacc-4274-9f1a-6fe05254672a",
        "url": "/v2/service_instances/242243f9-dacc-4274-9f1a-6fe05254672a",
        "created_at": "2015-05-15T16:53:34Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-750",
        "credentials": {
          "creds-key-311": "creds-val-311"
        },
        "service_plan_guid": "bfcc9577-ec03-4953-bf21-5dcbad8117cc",
        "space_guid": "c01023d1-19df-4973-ab5b-65104578adb2",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": null,
        "space_url": "/v2/spaces/c01023d1-19df-4973-ab5b-65104578adb2",
        "service_plan_url": "/v2/service_plans/bfcc9577-ec03-4953-bf21-5dcbad8117cc",
        "service_bindings_url": "/v2/service_instances/242243f9-dacc-4274-9f1a-6fe05254672a/service_bindings",
        "service_keys_url": "/v2/service_instances/242243f9-dacc-4274-9f1a-6fe05254672a/service_keys"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 67e9cf10-e8fd-4122-b855-bc7431c9b9bc
Content-Length: 1125
X-Content-Type-Options: nosniff