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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4NyIsImVtYWlsIjoiZW1haWwtMTUwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NDB9.9Bqi1rP7umjcQnRaQk9xK80yl6JVLtT0botxR1xQWp8
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4NyIsImVtYWlsIjoiZW1haWwtMTUwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NDB9.9Bqi1rP7umjcQnRaQk9xK80yl6JVLtT0botxR1xQWp8" \
	-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": "f662599a-2cc5-4cf5-bde4-7f327a42e5da",
        "url": "/v2/user_provided_service_instances/f662599a-2cc5-4cf5-bde4-7f327a42e5da",
        "created_at": "2015-11-03T00:53:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-870",
        "credentials": {
          "creds-key-349": "creds-val-349"
        },
        "space_guid": "789efe32-2cfa-42a6-bce0-bfed7a832c6a",
        "type": "user_provided_service_instance",
        "syslog_drain_url": "https://foo.com/url-50",
        "route_service_url": null,
        "space_url": "/v2/spaces/789efe32-2cfa-42a6-bce0-bfed7a832c6a",
        "service_bindings_url": "/v2/user_provided_service_instances/f662599a-2cc5-4cf5-bde4-7f327a42e5da/service_bindings",
        "routes_url": "/v2/user_provided_service_instances/f662599a-2cc5-4cf5-bde4-7f327a42e5da/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: da73fe8d-bc29-4a55-b6ae-0a35a0a112e5
Content-Length: 1002
X-Content-Type-Options: nosniff