Home
Version 3
Spaces API

Spaces API

List all Service Instances for the Space

GET /v2/spaces/:guid/service_instances

Fields

Name Description Default Valid Values Example Values

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
  • 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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTk5IiwiZW1haWwiOiJlbWFpbC02N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg5fQ.UZ46PWP7mcus6TP7eng0ekkGYRCJR2B9Nsf6no_GFFs
Host: example.org
Cookie: 

Route

GET /v2/spaces/a6ae9ee7-fe27-4a2b-89ab-e294f32c75fa/service_instances

cURL

curl "https://api.[your-domain.com]/v2/spaces/a6ae9ee7-fe27-4a2b-89ab-e294f32c75fa/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTk5IiwiZW1haWwiOiJlbWFpbC02N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg5fQ.UZ46PWP7mcus6TP7eng0ekkGYRCJR2B9Nsf6no_GFFs" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9efd4a31-fc2e-460d-8c45-6b0211f065de
Content-Length: 1022
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "c04048eb-de24-49a2-8107-9b40543baaa9",
        "url": "/v2/service_instances/c04048eb-de24-49a2-8107-9b40543baaa9",
        "created_at": "2015-02-13T22:34:49Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-264",
        "credentials": {
          "creds-key-144": "creds-val-144"
        },
        "service_plan_guid": "7798ff54-8d24-4d3a-b68d-3ccf2e7524f5",
        "space_guid": "a6ae9ee7-fe27-4a2b-89ab-e294f32c75fa",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": null,
        "space_url": "/v2/spaces/a6ae9ee7-fe27-4a2b-89ab-e294f32c75fa",
        "service_plan_url": "/v2/service_plans/7798ff54-8d24-4d3a-b68d-3ccf2e7524f5",
        "service_bindings_url": "/v2/service_instances/c04048eb-de24-49a2-8107-9b40543baaa9/service_bindings"
      }
    }
  ]
}