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.eyJ1c2VyX2lkIjoidWFhLWlkLTQxMyIsImVtYWlsIjoiZW1haWwtMzAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MTl9.245V9AgLF2RKbjzD1sZbtXlQMPkDu7XsHnz-c8KtClM
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQxMyIsImVtYWlsIjoiZW1haWwtMzAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MTl9.245V9AgLF2RKbjzD1sZbtXlQMPkDu7XsHnz-c8KtClM" \
	-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": "19d86a9b-6c63-4acb-9d00-3e1ae3f99baa",
        "url": "/v2/user_provided_service_instances/19d86a9b-6c63-4acb-9d00-3e1ae3f99baa",
        "created_at": "2015-08-31T21:50:19Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-2421",
        "credentials": {
          "creds-key-689": "creds-val-689"
        },
        "space_guid": "16763dc7-41db-4f18-885d-17d276b353a7",
        "type": "user_provided_service_instance",
        "syslog_drain_url": "https://foo.com/url-112",
        "space_url": "/v2/spaces/16763dc7-41db-4f18-885d-17d276b353a7",
        "service_bindings_url": "/v2/user_provided_service_instances/19d86a9b-6c63-4acb-9d00-3e1ae3f99baa/service_bindings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 760c6ed7-12a8-4d36-b615-ede854d51d53
Content-Length: 864
X-Content-Type-Options: nosniff