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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MiIsImVtYWlsIjoiZW1haWwtMjA2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjd9.rqA7irQiGfATfQizeBtIs6G3iEffJcyWwqn3xp69O-8
Host: example.org
Cookie: 

Route

GET /v2/spaces/eb326dd5-bdb7-4ce4-a695-7ec015f1aa59/service_instances

cURL

curl "https://api.[your-domain.com]/v2/spaces/eb326dd5-bdb7-4ce4-a695-7ec015f1aa59/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MiIsImVtYWlsIjoiZW1haWwtMjA2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjd9.rqA7irQiGfATfQizeBtIs6G3iEffJcyWwqn3xp69O-8" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6bcebe0a-c109-4a62-a81f-be3ee7dcefb7
Content-Length: 995
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "e7e94c14-391d-4530-aa13-a631657efe17",
        "url": "/v2/service_instances/e7e94c14-391d-4530-aa13-a631657efe17",
        "created_at": "2014-11-24T19:32:47+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-962",
        "credentials": {
          "creds-key-449": "creds-val-449"
        },
        "service_plan_guid": "baa732e3-3643-448b-a392-a3fc2c7a952c",
        "space_guid": "eb326dd5-bdb7-4ce4-a695-7ec015f1aa59",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "space_url": "/v2/spaces/eb326dd5-bdb7-4ce4-a695-7ec015f1aa59",
        "service_plan_url": "/v2/service_plans/baa732e3-3643-448b-a392-a3fc2c7a952c",
        "service_bindings_url": "/v2/service_instances/e7e94c14-391d-4530-aa13-a631657efe17/service_bindings"
      }
    }
  ]
}