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/ffa3cc31-8acf-40b0-abe1-942dbf414b7e/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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTk0IiwiZW1haWwiOiJlbWFpbC01OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM2ODI5Nzc3fQ.S6scxQ3ko6SfJYdCBXXlm-nqWFiBhAujbqVMtNA7Ln4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/spaces/ffa3cc31-8acf-40b0-abe1-942dbf414b7e/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTk0IiwiZW1haWwiOiJlbWFpbC01OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM2ODI5Nzc3fQ.S6scxQ3ko6SfJYdCBXXlm-nqWFiBhAujbqVMtNA7Ln4" \
	-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": "9bca6ba1-ad41-4d41-8c76-f0596049c320",
        "url": "/v2/service_instances/9bca6ba1-ad41-4d41-8c76-f0596049c320",
        "created_at": "2015-07-06T23:22:57Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-280",
        "credentials": {
          "creds-key-123": "creds-val-123"
        },
        "service_plan_guid": "3c324442-b62e-425e-acbf-d0b9c9cbd55c",
        "space_guid": "ffa3cc31-8acf-40b0-abe1-942dbf414b7e",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": null,
        "tags": [

        ],
        "space_url": "/v2/spaces/ffa3cc31-8acf-40b0-abe1-942dbf414b7e",
        "service_plan_url": "/v2/service_plans/3c324442-b62e-425e-acbf-d0b9c9cbd55c",
        "service_bindings_url": "/v2/service_instances/9bca6ba1-ad41-4d41-8c76-f0596049c320/service_bindings",
        "service_keys_url": "/v2/service_instances/9bca6ba1-ad41-4d41-8c76-f0596049c320/service_keys"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 86740c18-5de1-4e20-99a5-313471f957b4
Content-Length: 1155
X-Content-Type-Options: nosniff