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/7ffe04a9-6a7f-4efa-973d-c79383ec4efd/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.eyJ1c2VyX2lkIjoidWFhLWlkLTE3NCIsImVtYWlsIjoiZW1haWwtMTAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxMzl9.L0tAUjwwAgz4Wyc9nDjQK1utEUFemPITcOSK39CXB7E
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/spaces/7ffe04a9-6a7f-4efa-973d-c79383ec4efd/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3NCIsImVtYWlsIjoiZW1haWwtMTAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxMzl9.L0tAUjwwAgz4Wyc9nDjQK1utEUFemPITcOSK39CXB7E" \
	-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": "1605ecc0-fc6d-43ff-9563-f006c698e9c0",
        "url": "/v2/service_instances/1605ecc0-fc6d-43ff-9563-f006c698e9c0",
        "created_at": "2015-04-15T00:55:39Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1232",
        "credentials": {
          "creds-key-235": "creds-val-235"
        },
        "service_plan_guid": "9244348f-68d1-4dc2-a295-ec2a0fbe79ec",
        "space_guid": "7ffe04a9-6a7f-4efa-973d-c79383ec4efd",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": null,
        "space_url": "/v2/spaces/7ffe04a9-6a7f-4efa-973d-c79383ec4efd",
        "service_plan_url": "/v2/service_plans/9244348f-68d1-4dc2-a295-ec2a0fbe79ec",
        "service_bindings_url": "/v2/service_instances/1605ecc0-fc6d-43ff-9563-f006c698e9c0/service_bindings",
        "service_keys_url": "/v2/service_instances/1605ecc0-fc6d-43ff-9563-f006c698e9c0/service_keys"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a97160b4-d84b-4bb6-91f9-e89cb02ec780
Content-Length: 1126
X-Content-Type-Options: nosniff