Spaces API

List all Service Instances for the Space

GET /v2/spaces/:guid/service_instances

Request

Route

GET /v2/spaces/384c5315-17b1-4150-9159-6884adfde7d8/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, 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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyOSIsImVtYWlsIjoiZW1haWwtMTYxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDZ9.7EUKJ6S6a8QBko67FJZzFDjDhNmpXXjQhLchwfVtxmY
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/spaces/384c5315-17b1-4150-9159-6884adfde7d8/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyOSIsImVtYWlsIjoiZW1haWwtMTYxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDZ9.7EUKJ6S6a8QBko67FJZzFDjDhNmpXXjQhLchwfVtxmY" \
	-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": "fb4e0513-189c-4a44-94a5-8a1fdd65259d",
        "url": "/v2/service_instances/fb4e0513-189c-4a44-94a5-8a1fdd65259d",
        "created_at": "2015-08-31T21:50:06Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-843",
        "credentials": {
          "creds-key-346": "creds-val-346"
        },
        "service_plan_guid": "cdf7cb72-e9d3-4f1d-b6b4-39c1d2eec74d",
        "space_guid": "384c5315-17b1-4150-9159-6884adfde7d8",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": null,
        "tags": [

        ],
        "space_url": "/v2/spaces/384c5315-17b1-4150-9159-6884adfde7d8",
        "service_plan_url": "/v2/service_plans/cdf7cb72-e9d3-4f1d-b6b4-39c1d2eec74d",
        "service_bindings_url": "/v2/service_instances/fb4e0513-189c-4a44-94a5-8a1fdd65259d/service_bindings",
        "service_keys_url": "/v2/service_instances/fb4e0513-189c-4a44-94a5-8a1fdd65259d/service_keys",
        "routes_url": "/v2/service_instances/fb4e0513-189c-4a44-94a5-8a1fdd65259d/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 0ac93314-a84d-4790-bf6e-87df8de2bd1f
Content-Length: 1246
X-Content-Type-Options: nosniff