Home
Version 3
User Provided Service Instances API

User Provided Service Instances API

List all User Provided Service Instances

GET /v2/user_provided_service_instances

Request

Route

GET /v2/user_provided_service_instances

Parameters

Name Description Valid Values Example Values
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.eyJ1c2VyX2lkIjoidWFhLWlkLTIxIiwiZW1haWwiOiJlbWFpbC0yMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI3NDgwODQxfQ.qeogCix5DPTb_IO7MSbEdKlQXwzapNCGFLjHl75OVuA
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxIiwiZW1haWwiOiJlbWFpbC0yMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI3NDgwODQxfQ.qeogCix5DPTb_IO7MSbEdKlQXwzapNCGFLjHl75OVuA" \
	-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": "f1fd2007-2f18-4f15-baae-e2ca1b29f288",
        "url": "/v2/user_provided_service_instances/f1fd2007-2f18-4f15-baae-e2ca1b29f288",
        "created_at": "2015-03-20T18:27:21Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-110",
        "credentials": {
          "creds-key-56": "creds-val-56"
        },
        "space_guid": "c6bfeda1-bc81-478d-bc1c-805ed1c0ef5e",
        "type": "user_provided_service_instance",
        "syslog_drain_url": "https://foo.com/url-13",
        "space_url": "/v2/spaces/c6bfeda1-bc81-478d-bc1c-805ed1c0ef5e",
        "service_bindings_url": "/v2/user_provided_service_instances/f1fd2007-2f18-4f15-baae-e2ca1b29f288/service_bindings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: d3c55358-e693-4d06-9c44-87c071824f67
Content-Length: 860
X-Content-Type-Options: nosniff