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
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name, space_guid, 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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTc5IiwiZW1haWwiOiJlbWFpbC00NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDUzMzEwOTcyfQ.fyeN4ppV2T_4HRyUX8_ECJAspQJgI-JT-LAoNUevJ6o
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTc5IiwiZW1haWwiOiJlbWFpbC00NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDUzMzEwOTcyfQ.fyeN4ppV2T_4HRyUX8_ECJAspQJgI-JT-LAoNUevJ6o" \
	-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": "83a2ee71-ccdc-4073-b3dd-98df81d54d8b",
        "url": "/v2/user_provided_service_instances/83a2ee71-ccdc-4073-b3dd-98df81d54d8b",
        "created_at": "2016-01-13T17:29:32Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-157",
        "credentials": {
          "creds-key-9": "creds-val-9"
        },
        "space_guid": "a76a6307-ab70-42f0-9760-3110cf3506ca",
        "type": "user_provided_service_instance",
        "syslog_drain_url": "https://foo.com/url-14",
        "route_service_url": null,
        "space_url": "/v2/spaces/a76a6307-ab70-42f0-9760-3110cf3506ca",
        "service_bindings_url": "/v2/user_provided_service_instances/83a2ee71-ccdc-4073-b3dd-98df81d54d8b/service_bindings",
        "routes_url": "/v2/user_provided_service_instances/83a2ee71-ccdc-4073-b3dd-98df81d54d8b/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 998
X-Content-Type-Options: nosniff