Spaces API

List all Service Instances for the Space

GET /v2/spaces/:guid/service_instances

Request

Route

GET /v2/spaces/f858c6b3-f6b1-4ae8-81dd-8e8747657fbe/service_instances

Parameters

Name	Description	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, service_key_guid (Note that filtering on space_guid will return an empty list if you specify anything other than the guid included in the path.)	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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NCIsImVtYWlsIjoiZW1haWwtMjY3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDF9.zFe1cPREXsuypKLSFehaZuqO2Diy-ou-Kk29y_wZjvM
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/spaces/f858c6b3-f6b1-4ae8-81dd-8e8747657fbe/service_instances" -X GET \
        -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NCIsImVtYWlsIjoiZW1haWwtMjY3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDF9.zFe1cPREXsuypKLSFehaZuqO2Diy-ou-Kk29y_wZjvM" \
        -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": "9547e9ed-e460-4abe-bda3-7070b9835917",
        "url": "/v2/service_instances/9547e9ed-e460-4abe-bda3-7070b9835917",
        "created_at": "2016-06-08T16:41:41Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "name": "name-2104",
        "credentials": {
          "creds-key-60": "creds-val-60"
        },
        "service_plan_guid": "fcf57f7f-3c51-49b2-b252-dc24e0f7dcab",
        "space_guid": "f858c6b3-f6b1-4ae8-81dd-8e8747657fbe",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": null,
        "tags": [

        ],
        "maintenance_info": {},
        "space_url": "/v2/spaces/f858c6b3-f6b1-4ae8-81dd-8e8747657fbe",
        "service_plan_url": "/v2/service_plans/fcf57f7f-3c51-49b2-b252-dc24e0f7dcab",
        "service_bindings_url": "/v2/service_instances/9547e9ed-e460-4abe-bda3-7070b9835917/service_bindings",
        "service_keys_url": "/v2/service_instances/9547e9ed-e460-4abe-bda3-7070b9835917/service_keys",
        "routes_url": "/v2/service_instances/9547e9ed-e460-4abe-bda3-7070b9835917/routes",
        "shared_from_url": "/v2/service_instances/9547e9ed-e460-4abe-bda3-7070b9835917/shared_from",
        "shared_to_url": "/v2/service_instances/9547e9ed-e460-4abe-bda3-7070b9835917/shared_to",
        "service_instance_parameters_url": "/v2/service_instances/9547e9ed-e460-4abe-bda3-7070b9835917/parameters"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7b17b8f1-e010-4365-8e8a-c0d986d469d8
Content-Length: 1245
X-Content-Type-Options: nosniff