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

Fields

Name Description Default Valid Values Example Values

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU0IiwiZW1haWwiOiJlbWFpbC00N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzUzfQ.yo8W9t8pQ8xNYLhfDZA8ecnLfkSU-eS6NVltZD0jMoo
Host: example.org
Cookie: 

Route

GET /v2/user_provided_service_instances

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU0IiwiZW1haWwiOiJlbWFpbC00N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzUzfQ.yo8W9t8pQ8xNYLhfDZA8ecnLfkSU-eS6NVltZD0jMoo" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 57aa41ef-c8e5-449f-b302-794c069871af
Content-Length: 867
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "24106cd3-5756-45cd-879e-c27dfd780f72",
        "url": "/v2/user_provided_service_instances/24106cd3-5756-45cd-879e-c27dfd780f72",
        "created_at": "2014-11-24T19:32:33+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-368",
        "credentials": {
          "creds-key-110": "creds-val-110"
        },
        "space_guid": "7ad791af-b092-4d55-96ce-30d91e446eb1",
        "type": "user_provided_service_instance",
        "syslog_drain_url": "https://foo.com/url-13",
        "space_url": "/v2/spaces/7ad791af-b092-4d55-96ce-30d91e446eb1",
        "service_bindings_url": "/v2/user_provided_service_instances/24106cd3-5756-45cd-879e-c27dfd780f72/service_bindings"
      }
    }
  ]
}